ibm 1.78.0, Apr 30 25

ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud

ibm.KmsKeyAlias

Explore with Pulumi AI

ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud

ibm-cloud/terraform-provider-ibm

Example Usage

Create KmsKeyAlias Resource

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

Constructor syntax

new KmsKeyAlias(name: string, args: KmsKeyAliasArgs, opts?: CustomResourceOptions);

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

@overload
def KmsKeyAlias(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                alias: Optional[str] = None,
                instance_id: Optional[str] = None,
                endpoint_type: Optional[str] = None,
                existing_alias: Optional[str] = None,
                key_id: Optional[str] = None,
                kms_key_alias_id: Optional[str] = None)

func NewKmsKeyAlias(ctx *Context, name string, args KmsKeyAliasArgs, opts ...ResourceOption) (*KmsKeyAlias, error)

public KmsKeyAlias(string name, KmsKeyAliasArgs args, CustomResourceOptions? opts = null)

public KmsKeyAlias(String name, KmsKeyAliasArgs args)
public KmsKeyAlias(String name, KmsKeyAliasArgs args, CustomResourceOptions options)

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

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

name String: The unique name of the resource.
args KmsKeyAliasArgs: 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 kmsKeyAliasResource = new Ibm.KmsKeyAlias("kmsKeyAliasResource", new()
{
    Alias = "string",
    InstanceId = "string",
    EndpointType = "string",
    ExistingAlias = "string",
    KeyId = "string",
    KmsKeyAliasId = "string",
});

example, err := ibm.NewKmsKeyAlias(ctx, "kmsKeyAliasResource", &ibm.KmsKeyAliasArgs{
	Alias:         pulumi.String("string"),
	InstanceId:    pulumi.String("string"),
	EndpointType:  pulumi.String("string"),
	ExistingAlias: pulumi.String("string"),
	KeyId:         pulumi.String("string"),
	KmsKeyAliasId: pulumi.String("string"),
})

var kmsKeyAliasResource = new KmsKeyAlias("kmsKeyAliasResource", KmsKeyAliasArgs.builder()
    .alias("string")
    .instanceId("string")
    .endpointType("string")
    .existingAlias("string")
    .keyId("string")
    .kmsKeyAliasId("string")
    .build());

kms_key_alias_resource = ibm.KmsKeyAlias("kmsKeyAliasResource",
    alias="string",
    instance_id="string",
    endpoint_type="string",
    existing_alias="string",
    key_id="string",
    kms_key_alias_id="string")

const kmsKeyAliasResource = new ibm.KmsKeyAlias("kmsKeyAliasResource", {
    alias: "string",
    instanceId: "string",
    endpointType: "string",
    existingAlias: "string",
    keyId: "string",
    kmsKeyAliasId: "string",
});

type: ibm:KmsKeyAlias
properties:
    alias: string
    endpointType: string
    existingAlias: string
    instanceId: string
    keyId: string
    kmsKeyAliasId: string

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

Alias string: The alias name of the key.
InstanceId string: The hs-crypto or key protect instance GUID.
EndpointType string: The type of the public endpoint, or private endpoint to be used for creating keys.
ExistingAlias string: Existing Alias of the key.
KeyId string: The key ID for which alias has to be created.
KmsKeyAliasId string: (String) The CRN of the key.

Alias string: The alias name of the key.
InstanceId string: The hs-crypto or key protect instance GUID.
EndpointType string: The type of the public endpoint, or private endpoint to be used for creating keys.
ExistingAlias string: Existing Alias of the key.
KeyId string: The key ID for which alias has to be created.
KmsKeyAliasId string: (String) The CRN of the key.

alias String: The alias name of the key.
instanceId String: The hs-crypto or key protect instance GUID.
endpointType String: The type of the public endpoint, or private endpoint to be used for creating keys.
existingAlias String: Existing Alias of the key.
keyId String: The key ID for which alias has to be created.
kmsKeyAliasId String: (String) The CRN of the key.

alias string: The alias name of the key.
instanceId string: The hs-crypto or key protect instance GUID.
endpointType string: The type of the public endpoint, or private endpoint to be used for creating keys.
existingAlias string: Existing Alias of the key.
keyId string: The key ID for which alias has to be created.
kmsKeyAliasId string: (String) The CRN of the key.

alias str: The alias name of the key.
instance_id str: The hs-crypto or key protect instance GUID.
endpoint_type str: The type of the public endpoint, or private endpoint to be used for creating keys.
existing_alias str: Existing Alias of the key.
key_id str: The key ID for which alias has to be created.
kms_key_alias_id str: (String) The CRN of the key.

alias String: The alias name of the key.
instanceId String: The hs-crypto or key protect instance GUID.
endpointType String: The type of the public endpoint, or private endpoint to be used for creating keys.
existingAlias String: Existing Alias of the key.
keyId String: The key ID for which alias has to be created.
kmsKeyAliasId String: (String) The CRN of the key.

Outputs

All input properties are implicitly available as output properties. Additionally, the KmsKeyAlias 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 KmsKeyAlias Resource

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

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        alias: Optional[str] = None,
        endpoint_type: Optional[str] = None,
        existing_alias: Optional[str] = None,
        instance_id: Optional[str] = None,
        key_id: Optional[str] = None,
        kms_key_alias_id: Optional[str] = None) -> KmsKeyAlias

func GetKmsKeyAlias(ctx *Context, name string, id IDInput, state *KmsKeyAliasState, opts ...ResourceOption) (*KmsKeyAlias, error)

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

public static KmsKeyAlias get(String name, Output<String> id, KmsKeyAliasState state, CustomResourceOptions options)

resources:  _:    type: ibm:KmsKeyAlias    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:

Alias string: The alias name of the key.
EndpointType string: The type of the public endpoint, or private endpoint to be used for creating keys.
ExistingAlias string: Existing Alias of the key.
InstanceId string: The hs-crypto or key protect instance GUID.
KeyId string: The key ID for which alias has to be created.
KmsKeyAliasId string: (String) The CRN of the key.

Alias string: The alias name of the key.
EndpointType string: The type of the public endpoint, or private endpoint to be used for creating keys.
ExistingAlias string: Existing Alias of the key.
InstanceId string: The hs-crypto or key protect instance GUID.
KeyId string: The key ID for which alias has to be created.
KmsKeyAliasId string: (String) The CRN of the key.

alias String: The alias name of the key.
endpointType String: The type of the public endpoint, or private endpoint to be used for creating keys.
existingAlias String: Existing Alias of the key.
instanceId String: The hs-crypto or key protect instance GUID.
keyId String: The key ID for which alias has to be created.
kmsKeyAliasId String: (String) The CRN of the key.

alias string: The alias name of the key.
endpointType string: The type of the public endpoint, or private endpoint to be used for creating keys.
existingAlias string: Existing Alias of the key.
instanceId string: The hs-crypto or key protect instance GUID.
keyId string: The key ID for which alias has to be created.
kmsKeyAliasId string: (String) The CRN of the key.

alias str: The alias name of the key.
endpoint_type str: The type of the public endpoint, or private endpoint to be used for creating keys.
existing_alias str: Existing Alias of the key.
instance_id str: The hs-crypto or key protect instance GUID.
key_id str: The key ID for which alias has to be created.
kms_key_alias_id str: (String) The CRN of the key.

alias String: The alias name of the key.
endpointType String: The type of the public endpoint, or private endpoint to be used for creating keys.
existingAlias String: Existing Alias of the key.
instanceId String: The hs-crypto or key protect instance GUID.
keyId String: The key ID for which alias has to be created.
kmsKeyAliasId String: (String) The CRN of the key.

Package Details

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

ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud

ibm-cloud/terraform-provider-ibm

ibm.KmsKeyAlias

On this page

On this page

Example Usage

Create KmsKeyAlias Resource

Constructor syntax

Parameters

Constructor example

KmsKeyAlias Resource Properties

Inputs

Outputs

Look up Existing KmsKeyAlias Resource

Package Details

On this page

On this page