Docs Home
checkpoint 2.9.0 published on Monday, Apr 14, 2025 by checkpointsw
checkpoint.ManagementDeleteApiKey
Explore with Pulumi AI
checkpoint 2.9.0 published on Monday, Apr 14, 2025 by checkpointsw
Create ManagementDeleteApiKey Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ManagementDeleteApiKey(name: string, args?: ManagementDeleteApiKeyArgs, opts?: CustomResourceOptions);@overload
def ManagementDeleteApiKey(resource_name: str,
args: Optional[ManagementDeleteApiKeyArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def ManagementDeleteApiKey(resource_name: str,
opts: Optional[ResourceOptions] = None,
admin_name: Optional[str] = None,
admin_uid: Optional[str] = None,
api_key: Optional[str] = None,
management_delete_api_key_id: Optional[str] = None)func NewManagementDeleteApiKey(ctx *Context, name string, args *ManagementDeleteApiKeyArgs, opts ...ResourceOption) (*ManagementDeleteApiKey, error)public ManagementDeleteApiKey(string name, ManagementDeleteApiKeyArgs? args = null, CustomResourceOptions? opts = null)
public ManagementDeleteApiKey(String name, ManagementDeleteApiKeyArgs args)
public ManagementDeleteApiKey(String name, ManagementDeleteApiKeyArgs args, CustomResourceOptions options)
type: checkpoint:ManagementDeleteApiKey
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args ManagementDeleteApiKeyArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args ManagementDeleteApiKeyArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args ManagementDeleteApiKeyArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ManagementDeleteApiKeyArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ManagementDeleteApiKeyArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var managementDeleteApiKeyResource = new Checkpoint.ManagementDeleteApiKey("managementDeleteApiKeyResource", new()
{
AdminName = "string",
AdminUid = "string",
ApiKey = "string",
ManagementDeleteApiKeyId = "string",
});
example, err := checkpoint.NewManagementDeleteApiKey(ctx, "managementDeleteApiKeyResource", &checkpoint.ManagementDeleteApiKeyArgs{
AdminName: pulumi.String("string"),
AdminUid: pulumi.String("string"),
ApiKey: pulumi.String("string"),
ManagementDeleteApiKeyId: pulumi.String("string"),
})
var managementDeleteApiKeyResource = new ManagementDeleteApiKey("managementDeleteApiKeyResource", ManagementDeleteApiKeyArgs.builder()
.adminName("string")
.adminUid("string")
.apiKey("string")
.managementDeleteApiKeyId("string")
.build());
management_delete_api_key_resource = checkpoint.ManagementDeleteApiKey("managementDeleteApiKeyResource",
admin_name="string",
admin_uid="string",
api_key="string",
management_delete_api_key_id="string")
const managementDeleteApiKeyResource = new checkpoint.ManagementDeleteApiKey("managementDeleteApiKeyResource", {
adminName: "string",
adminUid: "string",
apiKey: "string",
managementDeleteApiKeyId: "string",
});
type: checkpoint:ManagementDeleteApiKey
properties:
adminName: string
adminUid: string
apiKey: string
managementDeleteApiKeyId: string
ManagementDeleteApiKey Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The ManagementDeleteApiKey resource accepts the following input properties:
- Admin
Name string - Administrator name to generate API key for.
- Admin
Uid string - Administrator uid to generate API key for.
- Api
Key string - API key to be deleted.
- Management
Delete stringApi Key Id
- Admin
Name string - Administrator name to generate API key for.
- Admin
Uid string - Administrator uid to generate API key for.
- Api
Key string - API key to be deleted.
- Management
Delete stringApi Key Id
- admin
Name String - Administrator name to generate API key for.
- admin
Uid String - Administrator uid to generate API key for.
- api
Key String - API key to be deleted.
- management
Delete StringApi Key Id
- admin
Name string - Administrator name to generate API key for.
- admin
Uid string - Administrator uid to generate API key for.
- api
Key string - API key to be deleted.
- management
Delete stringApi Key Id
- admin_
name str - Administrator name to generate API key for.
- admin_
uid str - Administrator uid to generate API key for.
- api_
key str - API key to be deleted.
- management_
delete_ strapi_ key_ id
- admin
Name String - Administrator name to generate API key for.
- admin
Uid String - Administrator uid to generate API key for.
- api
Key String - API key to be deleted.
- management
Delete StringApi Key Id
Outputs
All input properties are implicitly available as output properties. Additionally, the ManagementDeleteApiKey resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing ManagementDeleteApiKey Resource
Get an existing ManagementDeleteApiKey resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: ManagementDeleteApiKeyState, opts?: CustomResourceOptions): ManagementDeleteApiKey@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
admin_name: Optional[str] = None,
admin_uid: Optional[str] = None,
api_key: Optional[str] = None,
management_delete_api_key_id: Optional[str] = None) -> ManagementDeleteApiKeyfunc GetManagementDeleteApiKey(ctx *Context, name string, id IDInput, state *ManagementDeleteApiKeyState, opts ...ResourceOption) (*ManagementDeleteApiKey, error)public static ManagementDeleteApiKey Get(string name, Input<string> id, ManagementDeleteApiKeyState? state, CustomResourceOptions? opts = null)public static ManagementDeleteApiKey get(String name, Output<String> id, ManagementDeleteApiKeyState state, CustomResourceOptions options)resources: _: type: checkpoint:ManagementDeleteApiKey get: id: ${id}- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Admin
Name string - Administrator name to generate API key for.
- Admin
Uid string - Administrator uid to generate API key for.
- Api
Key string - API key to be deleted.
- Management
Delete stringApi Key Id
- Admin
Name string - Administrator name to generate API key for.
- Admin
Uid string - Administrator uid to generate API key for.
- Api
Key string - API key to be deleted.
- Management
Delete stringApi Key Id
- admin
Name String - Administrator name to generate API key for.
- admin
Uid String - Administrator uid to generate API key for.
- api
Key String - API key to be deleted.
- management
Delete StringApi Key Id
- admin
Name string - Administrator name to generate API key for.
- admin
Uid string - Administrator uid to generate API key for.
- api
Key string - API key to be deleted.
- management
Delete stringApi Key Id
- admin_
name str - Administrator name to generate API key for.
- admin_
uid str - Administrator uid to generate API key for.
- api_
key str - API key to be deleted.
- management_
delete_ strapi_ key_ id
- admin
Name String - Administrator name to generate API key for.
- admin
Uid String - Administrator uid to generate API key for.
- api
Key String - API key to be deleted.
- management
Delete StringApi Key Id
Package Details
- Repository
- checkpoint checkpointsw/terraform-provider-checkpoint
- License
- Notes
- This Pulumi package is based on the
checkpointTerraform Provider.
checkpoint 2.9.0 published on Monday, Apr 14, 2025 by checkpointsw