checkpoint 2.9.0, Apr 14 25

checkpoint 2.9.0 published on Monday, Apr 14, 2025 by checkpointsw

checkpointsw/terraform-provider-checkpoint

checkpoint.ManagementAddApiKey

Explore with Pulumi AI

checkpoint 2.9.0 published on Monday, Apr 14, 2025 by checkpointsw

checkpointsw/terraform-provider-checkpoint

Create ManagementAddApiKey Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new ManagementAddApiKey(name: string, args?: ManagementAddApiKeyArgs, opts?: CustomResourceOptions);

@overload
def ManagementAddApiKey(resource_name: str,
                        args: Optional[ManagementAddApiKeyArgs] = None,
                        opts: Optional[ResourceOptions] = None)

@overload
def ManagementAddApiKey(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        admin_name: Optional[str] = None,
                        admin_uid: Optional[str] = None,
                        management_add_api_key_id: Optional[str] = None)

func NewManagementAddApiKey(ctx *Context, name string, args *ManagementAddApiKeyArgs, opts ...ResourceOption) (*ManagementAddApiKey, error)

public ManagementAddApiKey(string name, ManagementAddApiKeyArgs? args = null, CustomResourceOptions? opts = null)

public ManagementAddApiKey(String name, ManagementAddApiKeyArgs args)
public ManagementAddApiKey(String name, ManagementAddApiKeyArgs args, CustomResourceOptions options)

type: checkpoint:ManagementAddApiKey
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 ManagementAddApiKeyArgs: 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 ManagementAddApiKeyArgs: 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 ManagementAddApiKeyArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ManagementAddApiKeyArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args ManagementAddApiKeyArgs: 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 managementAddApiKeyResource = new Checkpoint.ManagementAddApiKey("managementAddApiKeyResource", new()
{
    AdminName = "string",
    AdminUid = "string",
    ManagementAddApiKeyId = "string",
});

example, err := checkpoint.NewManagementAddApiKey(ctx, "managementAddApiKeyResource", &checkpoint.ManagementAddApiKeyArgs{
	AdminName:             pulumi.String("string"),
	AdminUid:              pulumi.String("string"),
	ManagementAddApiKeyId: pulumi.String("string"),
})

var managementAddApiKeyResource = new ManagementAddApiKey("managementAddApiKeyResource", ManagementAddApiKeyArgs.builder()
    .adminName("string")
    .adminUid("string")
    .managementAddApiKeyId("string")
    .build());

management_add_api_key_resource = checkpoint.ManagementAddApiKey("managementAddApiKeyResource",
    admin_name="string",
    admin_uid="string",
    management_add_api_key_id="string")

const managementAddApiKeyResource = new checkpoint.ManagementAddApiKey("managementAddApiKeyResource", {
    adminName: "string",
    adminUid: "string",
    managementAddApiKeyId: "string",
});

type: checkpoint:ManagementAddApiKey
properties:
    adminName: string
    adminUid: string
    managementAddApiKeyId: string

ManagementAddApiKey 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 ManagementAddApiKey resource accepts the following input properties:

AdminName string: Administrator name to generate API key for.
AdminUid string: Administrator uid to generate API key for.
ManagementAddApiKeyId string

AdminName string: Administrator name to generate API key for.
AdminUid string: Administrator uid to generate API key for.
ManagementAddApiKeyId string

adminName String: Administrator name to generate API key for.
adminUid String: Administrator uid to generate API key for.
managementAddApiKeyId String

adminName string: Administrator name to generate API key for.
adminUid string: Administrator uid to generate API key for.
managementAddApiKeyId string

admin_name str: Administrator name to generate API key for.
admin_uid str: Administrator uid to generate API key for.
management_add_api_key_id str

adminName String: Administrator name to generate API key for.
adminUid String: Administrator uid to generate API key for.
managementAddApiKeyId String

Outputs

All input properties are implicitly available as output properties. Additionally, the ManagementAddApiKey resource produces the following output properties:

ApiKey string: Represents the API Key to be used for Login.
Id string: The provider-assigned unique ID for this managed resource.

ApiKey string: Represents the API Key to be used for Login.
Id string: The provider-assigned unique ID for this managed resource.

apiKey String: Represents the API Key to be used for Login.
id String: The provider-assigned unique ID for this managed resource.

apiKey string: Represents the API Key to be used for Login.
id string: The provider-assigned unique ID for this managed resource.

api_key str: Represents the API Key to be used for Login.
id str: The provider-assigned unique ID for this managed resource.

apiKey String: Represents the API Key to be used for Login.
id String: The provider-assigned unique ID for this managed resource.

Look up Existing ManagementAddApiKey Resource

Get an existing ManagementAddApiKey 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?: ManagementAddApiKeyState, opts?: CustomResourceOptions): ManagementAddApiKey

@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_add_api_key_id: Optional[str] = None) -> ManagementAddApiKey

func GetManagementAddApiKey(ctx *Context, name string, id IDInput, state *ManagementAddApiKeyState, opts ...ResourceOption) (*ManagementAddApiKey, error)

public static ManagementAddApiKey Get(string name, Input<string> id, ManagementAddApiKeyState? state, CustomResourceOptions? opts = null)

public static ManagementAddApiKey get(String name, Output<String> id, ManagementAddApiKeyState state, CustomResourceOptions options)

resources:  _:    type: checkpoint:ManagementAddApiKey    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.

The following state arguments are supported:

AdminName string: Administrator name to generate API key for.
AdminUid string: Administrator uid to generate API key for.
ApiKey string: Represents the API Key to be used for Login.
ManagementAddApiKeyId string

AdminName string: Administrator name to generate API key for.
AdminUid string: Administrator uid to generate API key for.
ApiKey string: Represents the API Key to be used for Login.
ManagementAddApiKeyId string

adminName String: Administrator name to generate API key for.
adminUid String: Administrator uid to generate API key for.
apiKey String: Represents the API Key to be used for Login.
managementAddApiKeyId String

adminName string: Administrator name to generate API key for.
adminUid string: Administrator uid to generate API key for.
apiKey string: Represents the API Key to be used for Login.
managementAddApiKeyId string

admin_name str: Administrator name to generate API key for.
admin_uid str: Administrator uid to generate API key for.
api_key str: Represents the API Key to be used for Login.
management_add_api_key_id str

adminName String: Administrator name to generate API key for.
adminUid String: Administrator uid to generate API key for.
apiKey String: Represents the API Key to be used for Login.
managementAddApiKeyId String

Package Details

Repository: checkpoint checkpointsw/terraform-provider-checkpoint
License
Notes: This Pulumi package is based on the checkpoint Terraform Provider.

checkpoint 2.9.0 published on Monday, Apr 14, 2025 by checkpointsw

checkpointsw/terraform-provider-checkpoint

checkpoint.ManagementAddApiKey

On this page

On this page

Create ManagementAddApiKey Resource

Constructor syntax

Parameters

Constructor example

ManagementAddApiKey Resource Properties

Inputs

Outputs

Look up Existing ManagementAddApiKey Resource

Package Details

On this page

On this page