kms

package
v0.78.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 27, 2023 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	KeyOriginAwsKms   = KeyOrigin("AWS_KMS")
	KeyOriginExternal = KeyOrigin("EXTERNAL")
)
View Source 
const (
	KeySpecSymmetricDefault = KeySpec("SYMMETRIC_DEFAULT")
	KeySpecRsa2048          = KeySpec("RSA_2048")
	KeySpecRsa3072          = KeySpec("RSA_3072")
	KeySpecRsa4096          = KeySpec("RSA_4096")
	KeySpecEccNistP256      = KeySpec("ECC_NIST_P256")
	KeySpecEccNistP384      = KeySpec("ECC_NIST_P384")
	KeySpecEccNistP521      = KeySpec("ECC_NIST_P521")
	KeySpecEccSecgP256k1    = KeySpec("ECC_SECG_P256K1")
	KeySpecHmac224          = KeySpec("HMAC_224")
	KeySpecHmac256          = KeySpec("HMAC_256")
	KeySpecHmac384          = KeySpec("HMAC_384")
	KeySpecHmac512          = KeySpec("HMAC_512")
	KeySpecSm2              = KeySpec("SM2")
)
View Source 
const (
	KeyUsageEncryptDecrypt    = KeyUsage("ENCRYPT_DECRYPT")
	KeyUsageSignVerify        = KeyUsage("SIGN_VERIFY")
	KeyUsageGenerateVerifyMac = KeyUsage("GENERATE_VERIFY_MAC")
)

Variables

This section is empty.

Functions

This section is empty.

Types

type Alias 

type Alias struct {
	pulumi.CustomResourceState

	// Specifies the alias name. This value must begin with alias/ followed by a name, such as alias/ExampleAlias. The alias name cannot begin with alias/aws/. The alias/aws/ prefix is reserved for AWS managed keys.
	AliasName pulumi.StringOutput `pulumi:"aliasName"`
	// Identifies the AWS KMS key to which the alias refers. Specify the key ID or the Amazon Resource Name (ARN) of the AWS KMS key. You cannot specify another alias. For help finding the key ID and ARN, see Finding the Key ID and ARN in the AWS Key Management Service Developer Guide.
	TargetKeyId pulumi.StringOutput `pulumi:"targetKeyId"`
}

The AWS::KMS::Alias resource specifies a display name for an AWS KMS key in AWS Key Management Service (AWS KMS). You can use an alias to identify an AWS KMS key in cryptographic operations.

func GetAlias 

func GetAlias(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *AliasState, opts ...pulumi.ResourceOption) (*Alias, error)

GetAlias gets an existing Alias resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewAlias 

func NewAlias(ctx *pulumi.Context,
	name string, args *AliasArgs, opts ...pulumi.ResourceOption) (*Alias, error)

NewAlias registers a new resource with the given unique name, arguments, and options.

func (*Alias) ElementType 

func (*Alias) ElementType() reflect.Type

func (*Alias) ToAliasOutput 

func (i *Alias) ToAliasOutput() AliasOutput

func (*Alias) ToAliasOutputWithContext 

func (i *Alias) ToAliasOutputWithContext(ctx context.Context) AliasOutput

func (*Alias) ToOutput added in v0.76.0 

func (i *Alias) ToOutput(ctx context.Context) pulumix.Output[*Alias]

type AliasArgs 

type AliasArgs struct {
	// Specifies the alias name. This value must begin with alias/ followed by a name, such as alias/ExampleAlias. The alias name cannot begin with alias/aws/. The alias/aws/ prefix is reserved for AWS managed keys.
	AliasName pulumi.StringPtrInput
	// Identifies the AWS KMS key to which the alias refers. Specify the key ID or the Amazon Resource Name (ARN) of the AWS KMS key. You cannot specify another alias. For help finding the key ID and ARN, see Finding the Key ID and ARN in the AWS Key Management Service Developer Guide.
	TargetKeyId pulumi.StringInput
}

The set of arguments for constructing a Alias resource.

func (AliasArgs) ElementType 

func (AliasArgs) ElementType() reflect.Type

type AliasInput 

type AliasInput interface {
	pulumi.Input

	ToAliasOutput() AliasOutput
	ToAliasOutputWithContext(ctx context.Context) AliasOutput
}

type AliasOutput 

type AliasOutput struct{ *pulumi.OutputState }

func (AliasOutput) AliasName added in v0.17.0 

func (o AliasOutput) AliasName() pulumi.StringOutput

Specifies the alias name. This value must begin with alias/ followed by a name, such as alias/ExampleAlias. The alias name cannot begin with alias/aws/. The alias/aws/ prefix is reserved for AWS managed keys.

func (AliasOutput) ElementType 

func (AliasOutput) ElementType() reflect.Type

func (AliasOutput) TargetKeyId added in v0.17.0 

func (o AliasOutput) TargetKeyId() pulumi.StringOutput

Identifies the AWS KMS key to which the alias refers. Specify the key ID or the Amazon Resource Name (ARN) of the AWS KMS key. You cannot specify another alias. For help finding the key ID and ARN, see Finding the Key ID and ARN in the AWS Key Management Service Developer Guide.

func (AliasOutput) ToAliasOutput 

func (o AliasOutput) ToAliasOutput() AliasOutput

func (AliasOutput) ToAliasOutputWithContext 

func (o AliasOutput) ToAliasOutputWithContext(ctx context.Context) AliasOutput

func (AliasOutput) ToOutput added in v0.76.0 

func (o AliasOutput) ToOutput(ctx context.Context) pulumix.Output[*Alias]

type AliasState 

type AliasState struct {
}

func (AliasState) ElementType 

func (AliasState) ElementType() reflect.Type

type Key 

type Key struct {
	pulumi.CustomResourceState

	Arn pulumi.StringOutput `pulumi:"arn"`
	// Skips ("bypasses") the key policy lockout safety check. The default value is false.
	BypassPolicyLockoutSafetyCheck pulumi.BoolPtrOutput `pulumi:"bypassPolicyLockoutSafetyCheck"`
	// A description of the AWS KMS key. Use a description that helps you to distinguish this AWS KMS key from others in the account, such as its intended use.
	Description pulumi.StringPtrOutput `pulumi:"description"`
	// Enables automatic rotation of the key material for the specified AWS KMS key. By default, automation key rotation is not enabled.
	EnableKeyRotation pulumi.BoolPtrOutput `pulumi:"enableKeyRotation"`
	// Specifies whether the AWS KMS key is enabled. Disabled AWS KMS keys cannot be used in cryptographic operations.
	Enabled pulumi.BoolPtrOutput `pulumi:"enabled"`
	KeyId   pulumi.StringOutput  `pulumi:"keyId"`
	// The key policy that authorizes use of the AWS KMS key. The key policy must observe the following rules.
	KeyPolicy pulumi.AnyOutput `pulumi:"keyPolicy"`
	// Specifies the type of AWS KMS key to create. The default value is SYMMETRIC_DEFAULT. This property is required only for asymmetric AWS KMS keys. You can't change the KeySpec value after the AWS KMS key is created.
	KeySpec KeySpecPtrOutput `pulumi:"keySpec"`
	// Determines the cryptographic operations for which you can use the AWS KMS key. The default value is ENCRYPT_DECRYPT. This property is required only for asymmetric AWS KMS keys. You can't change the KeyUsage value after the AWS KMS key is created.
	KeyUsage KeyUsagePtrOutput `pulumi:"keyUsage"`
	// Specifies whether the AWS KMS key should be Multi-Region. You can't change the MultiRegion value after the AWS KMS key is created.
	MultiRegion pulumi.BoolPtrOutput `pulumi:"multiRegion"`
	// The source of the key material for the KMS key. You cannot change the origin after you create the KMS key. The default is AWS_KMS, which means that AWS KMS creates the key material.
	Origin KeyOriginPtrOutput `pulumi:"origin"`
	// Specifies the number of days in the waiting period before AWS KMS deletes an AWS KMS key that has been removed from a CloudFormation stack. Enter a value between 7 and 30 days. The default value is 30 days.
	PendingWindowInDays pulumi.IntPtrOutput `pulumi:"pendingWindowInDays"`
	// An array of key-value pairs to apply to this resource.
	Tags KeyTagArrayOutput `pulumi:"tags"`
}

The AWS::KMS::Key resource specifies an AWS KMS key in AWS Key Management Service (AWS KMS). Authorized users can use the AWS KMS key to encrypt and decrypt small amounts of data (up to 4096 bytes), but they are more commonly used to generate data keys. You can also use AWS KMS keys to encrypt data stored in AWS services that are integrated with AWS KMS or within their applications.

func GetKey 

func GetKey(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *KeyState, opts ...pulumi.ResourceOption) (*Key, error)

GetKey gets an existing Key resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewKey 

func NewKey(ctx *pulumi.Context,
	name string, args *KeyArgs, opts ...pulumi.ResourceOption) (*Key, error)

NewKey registers a new resource with the given unique name, arguments, and options.

func (*Key) ElementType 

func (*Key) ElementType() reflect.Type

func (*Key) ToKeyOutput 

func (i *Key) ToKeyOutput() KeyOutput

func (*Key) ToKeyOutputWithContext 

func (i *Key) ToKeyOutputWithContext(ctx context.Context) KeyOutput

func (*Key) ToOutput added in v0.76.0 

func (i *Key) ToOutput(ctx context.Context) pulumix.Output[*Key]

type KeyArgs 

type KeyArgs struct {
	// Skips ("bypasses") the key policy lockout safety check. The default value is false.
	BypassPolicyLockoutSafetyCheck pulumi.BoolPtrInput
	// A description of the AWS KMS key. Use a description that helps you to distinguish this AWS KMS key from others in the account, such as its intended use.
	Description pulumi.StringPtrInput
	// Enables automatic rotation of the key material for the specified AWS KMS key. By default, automation key rotation is not enabled.
	EnableKeyRotation pulumi.BoolPtrInput
	// Specifies whether the AWS KMS key is enabled. Disabled AWS KMS keys cannot be used in cryptographic operations.
	Enabled pulumi.BoolPtrInput
	// The key policy that authorizes use of the AWS KMS key. The key policy must observe the following rules.
	KeyPolicy pulumi.Input
	// Specifies the type of AWS KMS key to create. The default value is SYMMETRIC_DEFAULT. This property is required only for asymmetric AWS KMS keys. You can't change the KeySpec value after the AWS KMS key is created.
	KeySpec KeySpecPtrInput
	// Determines the cryptographic operations for which you can use the AWS KMS key. The default value is ENCRYPT_DECRYPT. This property is required only for asymmetric AWS KMS keys. You can't change the KeyUsage value after the AWS KMS key is created.
	KeyUsage KeyUsagePtrInput
	// Specifies whether the AWS KMS key should be Multi-Region. You can't change the MultiRegion value after the AWS KMS key is created.
	MultiRegion pulumi.BoolPtrInput
	// The source of the key material for the KMS key. You cannot change the origin after you create the KMS key. The default is AWS_KMS, which means that AWS KMS creates the key material.
	Origin KeyOriginPtrInput
	// Specifies the number of days in the waiting period before AWS KMS deletes an AWS KMS key that has been removed from a CloudFormation stack. Enter a value between 7 and 30 days. The default value is 30 days.
	PendingWindowInDays pulumi.IntPtrInput
	// An array of key-value pairs to apply to this resource.
	Tags KeyTagArrayInput
}

The set of arguments for constructing a Key resource.

func (KeyArgs) ElementType 

func (KeyArgs) ElementType() reflect.Type

type KeyInput 

type KeyInput interface {
	pulumi.Input

	ToKeyOutput() KeyOutput
	ToKeyOutputWithContext(ctx context.Context) KeyOutput
}

type KeyOrigin added in v0.70.0 

type KeyOrigin string

The source of the key material for the KMS key. You cannot change the origin after you create the KMS key. The default is AWS_KMS, which means that AWS KMS creates the key material.

func (KeyOrigin) ElementType added in v0.70.0 

func (KeyOrigin) ElementType() reflect.Type

func (KeyOrigin) ToKeyOriginOutput added in v0.70.0 

func (e KeyOrigin) ToKeyOriginOutput() KeyOriginOutput

func (KeyOrigin) ToKeyOriginOutputWithContext added in v0.70.0 

func (e KeyOrigin) ToKeyOriginOutputWithContext(ctx context.Context) KeyOriginOutput

func (KeyOrigin) ToKeyOriginPtrOutput added in v0.70.0 

func (e KeyOrigin) ToKeyOriginPtrOutput() KeyOriginPtrOutput

func (KeyOrigin) ToKeyOriginPtrOutputWithContext added in v0.70.0 

func (e KeyOrigin) ToKeyOriginPtrOutputWithContext(ctx context.Context) KeyOriginPtrOutput

func (KeyOrigin) ToStringOutput added in v0.70.0 

func (e KeyOrigin) ToStringOutput() pulumi.StringOutput

func (KeyOrigin) ToStringOutputWithContext added in v0.70.0 

func (e KeyOrigin) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (KeyOrigin) ToStringPtrOutput added in v0.70.0 

func (e KeyOrigin) ToStringPtrOutput() pulumi.StringPtrOutput

func (KeyOrigin) ToStringPtrOutputWithContext added in v0.70.0 

func (e KeyOrigin) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type KeyOriginInput added in v0.70.0 

type KeyOriginInput interface {
	pulumi.Input

	ToKeyOriginOutput() KeyOriginOutput
	ToKeyOriginOutputWithContext(context.Context) KeyOriginOutput
}

KeyOriginInput is an input type that accepts KeyOriginArgs and KeyOriginOutput values. You can construct a concrete instance of `KeyOriginInput` via: 

KeyOriginArgs{...}

type KeyOriginOutput added in v0.70.0 

type KeyOriginOutput struct{ *pulumi.OutputState }

func (KeyOriginOutput) ElementType added in v0.70.0 

func (KeyOriginOutput) ElementType() reflect.Type

func (KeyOriginOutput) ToKeyOriginOutput added in v0.70.0 

func (o KeyOriginOutput) ToKeyOriginOutput() KeyOriginOutput

func (KeyOriginOutput) ToKeyOriginOutputWithContext added in v0.70.0 

func (o KeyOriginOutput) ToKeyOriginOutputWithContext(ctx context.Context) KeyOriginOutput

func (KeyOriginOutput) ToKeyOriginPtrOutput added in v0.70.0 

func (o KeyOriginOutput) ToKeyOriginPtrOutput() KeyOriginPtrOutput

func (KeyOriginOutput) ToKeyOriginPtrOutputWithContext added in v0.70.0 

func (o KeyOriginOutput) ToKeyOriginPtrOutputWithContext(ctx context.Context) KeyOriginPtrOutput

func (KeyOriginOutput) ToOutput added in v0.76.0 

func (o KeyOriginOutput) ToOutput(ctx context.Context) pulumix.Output[KeyOrigin]

func (KeyOriginOutput) ToStringOutput added in v0.70.0 

func (o KeyOriginOutput) ToStringOutput() pulumi.StringOutput

func (KeyOriginOutput) ToStringOutputWithContext added in v0.70.0 

func (o KeyOriginOutput) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (KeyOriginOutput) ToStringPtrOutput added in v0.70.0 

func (o KeyOriginOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (KeyOriginOutput) ToStringPtrOutputWithContext added in v0.70.0 

func (o KeyOriginOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type KeyOriginPtrInput added in v0.70.0 

type KeyOriginPtrInput interface {
	pulumi.Input

	ToKeyOriginPtrOutput() KeyOriginPtrOutput
	ToKeyOriginPtrOutputWithContext(context.Context) KeyOriginPtrOutput
}

func KeyOriginPtr added in v0.70.0 

func KeyOriginPtr(v string) KeyOriginPtrInput

type KeyOriginPtrOutput added in v0.70.0 

type KeyOriginPtrOutput struct{ *pulumi.OutputState }

func (KeyOriginPtrOutput) Elem added in v0.70.0 

func (o KeyOriginPtrOutput) Elem() KeyOriginOutput

func (KeyOriginPtrOutput) ElementType added in v0.70.0 

func (KeyOriginPtrOutput) ElementType() reflect.Type

func (KeyOriginPtrOutput) ToKeyOriginPtrOutput added in v0.70.0 

func (o KeyOriginPtrOutput) ToKeyOriginPtrOutput() KeyOriginPtrOutput

func (KeyOriginPtrOutput) ToKeyOriginPtrOutputWithContext added in v0.70.0 

func (o KeyOriginPtrOutput) ToKeyOriginPtrOutputWithContext(ctx context.Context) KeyOriginPtrOutput

func (KeyOriginPtrOutput) ToOutput added in v0.76.0 

func (o KeyOriginPtrOutput) ToOutput(ctx context.Context) pulumix.Output[*KeyOrigin]

func (KeyOriginPtrOutput) ToStringPtrOutput added in v0.70.0 

func (o KeyOriginPtrOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (KeyOriginPtrOutput) ToStringPtrOutputWithContext added in v0.70.0 

func (o KeyOriginPtrOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type KeyOutput 

type KeyOutput struct{ *pulumi.OutputState }

func (KeyOutput) Arn added in v0.17.0 

func (o KeyOutput) Arn() pulumi.StringOutput

func (KeyOutput) BypassPolicyLockoutSafetyCheck added in v0.73.0 

func (o KeyOutput) BypassPolicyLockoutSafetyCheck() pulumi.BoolPtrOutput

Skips ("bypasses") the key policy lockout safety check. The default value is false.

func (KeyOutput) Description added in v0.17.0 

func (o KeyOutput) Description() pulumi.StringPtrOutput

A description of the AWS KMS key. Use a description that helps you to distinguish this AWS KMS key from others in the account, such as its intended use.

func (KeyOutput) ElementType 

func (KeyOutput) ElementType() reflect.Type

func (KeyOutput) EnableKeyRotation added in v0.17.0 

func (o KeyOutput) EnableKeyRotation() pulumi.BoolPtrOutput

Enables automatic rotation of the key material for the specified AWS KMS key. By default, automation key rotation is not enabled.

func (KeyOutput) Enabled added in v0.17.0 

func (o KeyOutput) Enabled() pulumi.BoolPtrOutput

Specifies whether the AWS KMS key is enabled. Disabled AWS KMS keys cannot be used in cryptographic operations.

func (KeyOutput) KeyId added in v0.17.0 

func (o KeyOutput) KeyId() pulumi.StringOutput

func (KeyOutput) KeyPolicy added in v0.17.0 

func (o KeyOutput) KeyPolicy() pulumi.AnyOutput

The key policy that authorizes use of the AWS KMS key. The key policy must observe the following rules.

func (KeyOutput) KeySpec added in v0.17.0 

func (o KeyOutput) KeySpec() KeySpecPtrOutput

Specifies the type of AWS KMS key to create. The default value is SYMMETRIC_DEFAULT. This property is required only for asymmetric AWS KMS keys. You can't change the KeySpec value after the AWS KMS key is created.

func (KeyOutput) KeyUsage added in v0.17.0 

func (o KeyOutput) KeyUsage() KeyUsagePtrOutput

Determines the cryptographic operations for which you can use the AWS KMS key. The default value is ENCRYPT_DECRYPT. This property is required only for asymmetric AWS KMS keys. You can't change the KeyUsage value after the AWS KMS key is created.

func (KeyOutput) MultiRegion added in v0.17.0 

func (o KeyOutput) MultiRegion() pulumi.BoolPtrOutput

Specifies whether the AWS KMS key should be Multi-Region. You can't change the MultiRegion value after the AWS KMS key is created.

func (KeyOutput) Origin added in v0.70.0 

func (o KeyOutput) Origin() KeyOriginPtrOutput

The source of the key material for the KMS key. You cannot change the origin after you create the KMS key. The default is AWS_KMS, which means that AWS KMS creates the key material.

func (KeyOutput) PendingWindowInDays added in v0.17.0 

func (o KeyOutput) PendingWindowInDays() pulumi.IntPtrOutput

Specifies the number of days in the waiting period before AWS KMS deletes an AWS KMS key that has been removed from a CloudFormation stack. Enter a value between 7 and 30 days. The default value is 30 days.

func (KeyOutput) Tags added in v0.17.0 

func (o KeyOutput) Tags() KeyTagArrayOutput

An array of key-value pairs to apply to this resource.

func (KeyOutput) ToKeyOutput 

func (o KeyOutput) ToKeyOutput() KeyOutput

func (KeyOutput) ToKeyOutputWithContext 

func (o KeyOutput) ToKeyOutputWithContext(ctx context.Context) KeyOutput

func (KeyOutput) ToOutput added in v0.76.0 

func (o KeyOutput) ToOutput(ctx context.Context) pulumix.Output[*Key]

type KeySpec added in v0.2.0 

type KeySpec string

Specifies the type of AWS KMS key to create. The default value is SYMMETRIC_DEFAULT. This property is required only for asymmetric AWS KMS keys. You can't change the KeySpec value after the AWS KMS key is created.

func (KeySpec) ElementType added in v0.2.0 

func (KeySpec) ElementType() reflect.Type

func (KeySpec) ToKeySpecOutput added in v0.2.0 

func (e KeySpec) ToKeySpecOutput() KeySpecOutput

func (KeySpec) ToKeySpecOutputWithContext added in v0.2.0 

func (e KeySpec) ToKeySpecOutputWithContext(ctx context.Context) KeySpecOutput

func (KeySpec) ToKeySpecPtrOutput added in v0.2.0 

func (e KeySpec) ToKeySpecPtrOutput() KeySpecPtrOutput

func (KeySpec) ToKeySpecPtrOutputWithContext added in v0.2.0 

func (e KeySpec) ToKeySpecPtrOutputWithContext(ctx context.Context) KeySpecPtrOutput

func (KeySpec) ToStringOutput added in v0.2.0 

func (e KeySpec) ToStringOutput() pulumi.StringOutput

func (KeySpec) ToStringOutputWithContext added in v0.2.0 

func (e KeySpec) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (KeySpec) ToStringPtrOutput added in v0.2.0 

func (e KeySpec) ToStringPtrOutput() pulumi.StringPtrOutput

func (KeySpec) ToStringPtrOutputWithContext added in v0.2.0 

func (e KeySpec) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type KeySpecInput added in v0.2.0 

type KeySpecInput interface {
	pulumi.Input

	ToKeySpecOutput() KeySpecOutput
	ToKeySpecOutputWithContext(context.Context) KeySpecOutput
}

KeySpecInput is an input type that accepts KeySpecArgs and KeySpecOutput values. You can construct a concrete instance of `KeySpecInput` via: 

KeySpecArgs{...}

type KeySpecOutput added in v0.2.0 

type KeySpecOutput struct{ *pulumi.OutputState }

func (KeySpecOutput) ElementType added in v0.2.0 

func (KeySpecOutput) ElementType() reflect.Type

func (KeySpecOutput) ToKeySpecOutput added in v0.2.0 

func (o KeySpecOutput) ToKeySpecOutput() KeySpecOutput

func (KeySpecOutput) ToKeySpecOutputWithContext added in v0.2.0 

func (o KeySpecOutput) ToKeySpecOutputWithContext(ctx context.Context) KeySpecOutput

func (KeySpecOutput) ToKeySpecPtrOutput added in v0.2.0 

func (o KeySpecOutput) ToKeySpecPtrOutput() KeySpecPtrOutput

func (KeySpecOutput) ToKeySpecPtrOutputWithContext added in v0.2.0 

func (o KeySpecOutput) ToKeySpecPtrOutputWithContext(ctx context.Context) KeySpecPtrOutput

func (KeySpecOutput) ToOutput added in v0.76.0 

func (o KeySpecOutput) ToOutput(ctx context.Context) pulumix.Output[KeySpec]

func (KeySpecOutput) ToStringOutput added in v0.2.0 

func (o KeySpecOutput) ToStringOutput() pulumi.StringOutput

func (KeySpecOutput) ToStringOutputWithContext added in v0.2.0 

func (o KeySpecOutput) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (KeySpecOutput) ToStringPtrOutput added in v0.2.0 

func (o KeySpecOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (KeySpecOutput) ToStringPtrOutputWithContext added in v0.2.0 

func (o KeySpecOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type KeySpecPtrInput added in v0.2.0 

type KeySpecPtrInput interface {
	pulumi.Input

	ToKeySpecPtrOutput() KeySpecPtrOutput
	ToKeySpecPtrOutputWithContext(context.Context) KeySpecPtrOutput
}

func KeySpecPtr added in v0.2.0 

func KeySpecPtr(v string) KeySpecPtrInput

type KeySpecPtrOutput added in v0.2.0 

type KeySpecPtrOutput struct{ *pulumi.OutputState }

func (KeySpecPtrOutput) Elem added in v0.2.0 

func (o KeySpecPtrOutput) Elem() KeySpecOutput

func (KeySpecPtrOutput) ElementType added in v0.2.0 

func (KeySpecPtrOutput) ElementType() reflect.Type

func (KeySpecPtrOutput) ToKeySpecPtrOutput added in v0.2.0 

func (o KeySpecPtrOutput) ToKeySpecPtrOutput() KeySpecPtrOutput

func (KeySpecPtrOutput) ToKeySpecPtrOutputWithContext added in v0.2.0 

func (o KeySpecPtrOutput) ToKeySpecPtrOutputWithContext(ctx context.Context) KeySpecPtrOutput

func (KeySpecPtrOutput) ToOutput added in v0.76.0 

func (o KeySpecPtrOutput) ToOutput(ctx context.Context) pulumix.Output[*KeySpec]

func (KeySpecPtrOutput) ToStringPtrOutput added in v0.2.0 

func (o KeySpecPtrOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (KeySpecPtrOutput) ToStringPtrOutputWithContext added in v0.2.0 

func (o KeySpecPtrOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type KeyState 

type KeyState struct {
}

func (KeyState) ElementType 

func (KeyState) ElementType() reflect.Type

type KeyTag 

type KeyTag struct {
	// The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
	Key string `pulumi:"key"`
	// The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
	Value string `pulumi:"value"`
}

A key-value pair to associate with a resource.

type KeyTagArgs 

type KeyTagArgs struct {
	// The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
	Key pulumi.StringInput `pulumi:"key"`
	// The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
	Value pulumi.StringInput `pulumi:"value"`
}

A key-value pair to associate with a resource.

func (KeyTagArgs) ElementType 

func (KeyTagArgs) ElementType() reflect.Type

func (KeyTagArgs) ToKeyTagOutput 

func (i KeyTagArgs) ToKeyTagOutput() KeyTagOutput

func (KeyTagArgs) ToKeyTagOutputWithContext 

func (i KeyTagArgs) ToKeyTagOutputWithContext(ctx context.Context) KeyTagOutput

func (KeyTagArgs) ToOutput added in v0.76.0 

func (i KeyTagArgs) ToOutput(ctx context.Context) pulumix.Output[KeyTag]

type KeyTagArray 

type KeyTagArray []KeyTagInput

func (KeyTagArray) ElementType 

func (KeyTagArray) ElementType() reflect.Type

func (KeyTagArray) ToKeyTagArrayOutput 

func (i KeyTagArray) ToKeyTagArrayOutput() KeyTagArrayOutput

func (KeyTagArray) ToKeyTagArrayOutputWithContext 

func (i KeyTagArray) ToKeyTagArrayOutputWithContext(ctx context.Context) KeyTagArrayOutput

func (KeyTagArray) ToOutput added in v0.76.0 

func (i KeyTagArray) ToOutput(ctx context.Context) pulumix.Output[[]KeyTag]

type KeyTagArrayInput 

type KeyTagArrayInput interface {
	pulumi.Input

	ToKeyTagArrayOutput() KeyTagArrayOutput
	ToKeyTagArrayOutputWithContext(context.Context) KeyTagArrayOutput
}

KeyTagArrayInput is an input type that accepts KeyTagArray and KeyTagArrayOutput values. You can construct a concrete instance of `KeyTagArrayInput` via: 

KeyTagArray{ KeyTagArgs{...} }

type KeyTagArrayOutput 

type KeyTagArrayOutput struct{ *pulumi.OutputState }

func (KeyTagArrayOutput) ElementType 

func (KeyTagArrayOutput) ElementType() reflect.Type

func (KeyTagArrayOutput) Index 

func (o KeyTagArrayOutput) Index(i pulumi.IntInput) KeyTagOutput

func (KeyTagArrayOutput) ToKeyTagArrayOutput 

func (o KeyTagArrayOutput) ToKeyTagArrayOutput() KeyTagArrayOutput

func (KeyTagArrayOutput) ToKeyTagArrayOutputWithContext 

func (o KeyTagArrayOutput) ToKeyTagArrayOutputWithContext(ctx context.Context) KeyTagArrayOutput

func (KeyTagArrayOutput) ToOutput added in v0.76.0 

func (o KeyTagArrayOutput) ToOutput(ctx context.Context) pulumix.Output[[]KeyTag]

type KeyTagInput 

type KeyTagInput interface {
	pulumi.Input

	ToKeyTagOutput() KeyTagOutput
	ToKeyTagOutputWithContext(context.Context) KeyTagOutput
}

KeyTagInput is an input type that accepts KeyTagArgs and KeyTagOutput values. You can construct a concrete instance of `KeyTagInput` via: 

KeyTagArgs{...}

type KeyTagOutput 

type KeyTagOutput struct{ *pulumi.OutputState }

A key-value pair to associate with a resource.

func (KeyTagOutput) ElementType 

func (KeyTagOutput) ElementType() reflect.Type

func (KeyTagOutput) Key 

func (o KeyTagOutput) Key() pulumi.StringOutput

The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

func (KeyTagOutput) ToKeyTagOutput 

func (o KeyTagOutput) ToKeyTagOutput() KeyTagOutput

func (KeyTagOutput) ToKeyTagOutputWithContext 

func (o KeyTagOutput) ToKeyTagOutputWithContext(ctx context.Context) KeyTagOutput

func (KeyTagOutput) ToOutput added in v0.76.0 

func (o KeyTagOutput) ToOutput(ctx context.Context) pulumix.Output[KeyTag]

func (KeyTagOutput) Value 

func (o KeyTagOutput) Value() pulumi.StringOutput

The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

type KeyUsage added in v0.2.0 

type KeyUsage string

Determines the cryptographic operations for which you can use the AWS KMS key. The default value is ENCRYPT_DECRYPT. This property is required only for asymmetric AWS KMS keys. You can't change the KeyUsage value after the AWS KMS key is created.

func (KeyUsage) ElementType added in v0.2.0 

func (KeyUsage) ElementType() reflect.Type

func (KeyUsage) ToKeyUsageOutput added in v0.2.0 

func (e KeyUsage) ToKeyUsageOutput() KeyUsageOutput

func (KeyUsage) ToKeyUsageOutputWithContext added in v0.2.0 

func (e KeyUsage) ToKeyUsageOutputWithContext(ctx context.Context) KeyUsageOutput

func (KeyUsage) ToKeyUsagePtrOutput added in v0.2.0 

func (e KeyUsage) ToKeyUsagePtrOutput() KeyUsagePtrOutput

func (KeyUsage) ToKeyUsagePtrOutputWithContext added in v0.2.0 

func (e KeyUsage) ToKeyUsagePtrOutputWithContext(ctx context.Context) KeyUsagePtrOutput

func (KeyUsage) ToStringOutput added in v0.2.0 

func (e KeyUsage) ToStringOutput() pulumi.StringOutput

func (KeyUsage) ToStringOutputWithContext added in v0.2.0 

func (e KeyUsage) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (KeyUsage) ToStringPtrOutput added in v0.2.0 

func (e KeyUsage) ToStringPtrOutput() pulumi.StringPtrOutput

func (KeyUsage) ToStringPtrOutputWithContext added in v0.2.0 

func (e KeyUsage) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type KeyUsageInput added in v0.2.0 

type KeyUsageInput interface {
	pulumi.Input

	ToKeyUsageOutput() KeyUsageOutput
	ToKeyUsageOutputWithContext(context.Context) KeyUsageOutput
}

KeyUsageInput is an input type that accepts KeyUsageArgs and KeyUsageOutput values. You can construct a concrete instance of `KeyUsageInput` via: 

KeyUsageArgs{...}

type KeyUsageOutput added in v0.2.0 

type KeyUsageOutput struct{ *pulumi.OutputState }

func (KeyUsageOutput) ElementType added in v0.2.0 

func (KeyUsageOutput) ElementType() reflect.Type

func (KeyUsageOutput) ToKeyUsageOutput added in v0.2.0 

func (o KeyUsageOutput) ToKeyUsageOutput() KeyUsageOutput

func (KeyUsageOutput) ToKeyUsageOutputWithContext added in v0.2.0 

func (o KeyUsageOutput) ToKeyUsageOutputWithContext(ctx context.Context) KeyUsageOutput

func (KeyUsageOutput) ToKeyUsagePtrOutput added in v0.2.0 

func (o KeyUsageOutput) ToKeyUsagePtrOutput() KeyUsagePtrOutput

func (KeyUsageOutput) ToKeyUsagePtrOutputWithContext added in v0.2.0 

func (o KeyUsageOutput) ToKeyUsagePtrOutputWithContext(ctx context.Context) KeyUsagePtrOutput

func (KeyUsageOutput) ToOutput added in v0.76.0 

func (o KeyUsageOutput) ToOutput(ctx context.Context) pulumix.Output[KeyUsage]

func (KeyUsageOutput) ToStringOutput added in v0.2.0 

func (o KeyUsageOutput) ToStringOutput() pulumi.StringOutput

func (KeyUsageOutput) ToStringOutputWithContext added in v0.2.0 

func (o KeyUsageOutput) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (KeyUsageOutput) ToStringPtrOutput added in v0.2.0 

func (o KeyUsageOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (KeyUsageOutput) ToStringPtrOutputWithContext added in v0.2.0 

func (o KeyUsageOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type KeyUsagePtrInput added in v0.2.0 

type KeyUsagePtrInput interface {
	pulumi.Input

	ToKeyUsagePtrOutput() KeyUsagePtrOutput
	ToKeyUsagePtrOutputWithContext(context.Context) KeyUsagePtrOutput
}

func KeyUsagePtr added in v0.2.0 

func KeyUsagePtr(v string) KeyUsagePtrInput

type KeyUsagePtrOutput added in v0.2.0 

type KeyUsagePtrOutput struct{ *pulumi.OutputState }

func (KeyUsagePtrOutput) Elem added in v0.2.0 

func (o KeyUsagePtrOutput) Elem() KeyUsageOutput

func (KeyUsagePtrOutput) ElementType added in v0.2.0 

func (KeyUsagePtrOutput) ElementType() reflect.Type

func (KeyUsagePtrOutput) ToKeyUsagePtrOutput added in v0.2.0 

func (o KeyUsagePtrOutput) ToKeyUsagePtrOutput() KeyUsagePtrOutput

func (KeyUsagePtrOutput) ToKeyUsagePtrOutputWithContext added in v0.2.0 

func (o KeyUsagePtrOutput) ToKeyUsagePtrOutputWithContext(ctx context.Context) KeyUsagePtrOutput

func (KeyUsagePtrOutput) ToOutput added in v0.76.0 

func (o KeyUsagePtrOutput) ToOutput(ctx context.Context) pulumix.Output[*KeyUsage]

func (KeyUsagePtrOutput) ToStringPtrOutput added in v0.2.0 

func (o KeyUsagePtrOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (KeyUsagePtrOutput) ToStringPtrOutputWithContext added in v0.2.0 

func (o KeyUsagePtrOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type LookupAliasArgs added in v0.12.0 

type LookupAliasArgs struct {
	// Specifies the alias name. This value must begin with alias/ followed by a name, such as alias/ExampleAlias. The alias name cannot begin with alias/aws/. The alias/aws/ prefix is reserved for AWS managed keys.
	AliasName string `pulumi:"aliasName"`
}

type LookupAliasOutputArgs added in v0.12.0 

type LookupAliasOutputArgs struct {
	// Specifies the alias name. This value must begin with alias/ followed by a name, such as alias/ExampleAlias. The alias name cannot begin with alias/aws/. The alias/aws/ prefix is reserved for AWS managed keys.
	AliasName pulumi.StringInput `pulumi:"aliasName"`
}

func (LookupAliasOutputArgs) ElementType added in v0.12.0 

func (LookupAliasOutputArgs) ElementType() reflect.Type

type LookupAliasResult added in v0.12.0 

type LookupAliasResult struct {
	// Identifies the AWS KMS key to which the alias refers. Specify the key ID or the Amazon Resource Name (ARN) of the AWS KMS key. You cannot specify another alias. For help finding the key ID and ARN, see Finding the Key ID and ARN in the AWS Key Management Service Developer Guide.
	TargetKeyId *string `pulumi:"targetKeyId"`
}

func LookupAlias added in v0.12.0 

func LookupAlias(ctx *pulumi.Context, args *LookupAliasArgs, opts ...pulumi.InvokeOption) (*LookupAliasResult, error)

The AWS::KMS::Alias resource specifies a display name for an AWS KMS key in AWS Key Management Service (AWS KMS). You can use an alias to identify an AWS KMS key in cryptographic operations.

type LookupAliasResultOutput added in v0.12.0 

type LookupAliasResultOutput struct{ *pulumi.OutputState }

func LookupAliasOutput added in v0.12.0 

func LookupAliasOutput(ctx *pulumi.Context, args LookupAliasOutputArgs, opts ...pulumi.InvokeOption) LookupAliasResultOutput

func (LookupAliasResultOutput) ElementType added in v0.12.0 

func (LookupAliasResultOutput) ElementType() reflect.Type

func (LookupAliasResultOutput) TargetKeyId added in v0.12.0 

func (o LookupAliasResultOutput) TargetKeyId() pulumi.StringPtrOutput

Identifies the AWS KMS key to which the alias refers. Specify the key ID or the Amazon Resource Name (ARN) of the AWS KMS key. You cannot specify another alias. For help finding the key ID and ARN, see Finding the Key ID and ARN in the AWS Key Management Service Developer Guide.

func (LookupAliasResultOutput) ToLookupAliasResultOutput added in v0.12.0 

func (o LookupAliasResultOutput) ToLookupAliasResultOutput() LookupAliasResultOutput

func (LookupAliasResultOutput) ToLookupAliasResultOutputWithContext added in v0.12.0 

func (o LookupAliasResultOutput) ToLookupAliasResultOutputWithContext(ctx context.Context) LookupAliasResultOutput

func (LookupAliasResultOutput) ToOutput added in v0.76.0 

func (o LookupAliasResultOutput) ToOutput(ctx context.Context) pulumix.Output[LookupAliasResult]

type LookupKeyArgs added in v0.12.0 

type LookupKeyArgs struct {
	KeyId string `pulumi:"keyId"`
}

type LookupKeyOutputArgs added in v0.12.0 

type LookupKeyOutputArgs struct {
	KeyId pulumi.StringInput `pulumi:"keyId"`
}

func (LookupKeyOutputArgs) ElementType added in v0.12.0 

func (LookupKeyOutputArgs) ElementType() reflect.Type

type LookupKeyResult added in v0.12.0 

type LookupKeyResult struct {
	Arn *string `pulumi:"arn"`
	// A description of the AWS KMS key. Use a description that helps you to distinguish this AWS KMS key from others in the account, such as its intended use.
	Description *string `pulumi:"description"`
	// Enables automatic rotation of the key material for the specified AWS KMS key. By default, automation key rotation is not enabled.
	EnableKeyRotation *bool `pulumi:"enableKeyRotation"`
	// Specifies whether the AWS KMS key is enabled. Disabled AWS KMS keys cannot be used in cryptographic operations.
	Enabled *bool   `pulumi:"enabled"`
	KeyId   *string `pulumi:"keyId"`
	// The key policy that authorizes use of the AWS KMS key. The key policy must observe the following rules.
	KeyPolicy interface{} `pulumi:"keyPolicy"`
	// Specifies the type of AWS KMS key to create. The default value is SYMMETRIC_DEFAULT. This property is required only for asymmetric AWS KMS keys. You can't change the KeySpec value after the AWS KMS key is created.
	KeySpec *KeySpec `pulumi:"keySpec"`
	// Determines the cryptographic operations for which you can use the AWS KMS key. The default value is ENCRYPT_DECRYPT. This property is required only for asymmetric AWS KMS keys. You can't change the KeyUsage value after the AWS KMS key is created.
	KeyUsage *KeyUsage `pulumi:"keyUsage"`
	// Specifies whether the AWS KMS key should be Multi-Region. You can't change the MultiRegion value after the AWS KMS key is created.
	MultiRegion *bool `pulumi:"multiRegion"`
	// The source of the key material for the KMS key. You cannot change the origin after you create the KMS key. The default is AWS_KMS, which means that AWS KMS creates the key material.
	Origin *KeyOrigin `pulumi:"origin"`
	// An array of key-value pairs to apply to this resource.
	Tags []KeyTag `pulumi:"tags"`
}

func LookupKey added in v0.12.0 

func LookupKey(ctx *pulumi.Context, args *LookupKeyArgs, opts ...pulumi.InvokeOption) (*LookupKeyResult, error)

The AWS::KMS::Key resource specifies an AWS KMS key in AWS Key Management Service (AWS KMS). Authorized users can use the AWS KMS key to encrypt and decrypt small amounts of data (up to 4096 bytes), but they are more commonly used to generate data keys. You can also use AWS KMS keys to encrypt data stored in AWS services that are integrated with AWS KMS or within their applications.

type LookupKeyResultOutput added in v0.12.0 

type LookupKeyResultOutput struct{ *pulumi.OutputState }

func LookupKeyOutput added in v0.12.0 

func LookupKeyOutput(ctx *pulumi.Context, args LookupKeyOutputArgs, opts ...pulumi.InvokeOption) LookupKeyResultOutput

func (LookupKeyResultOutput) Arn added in v0.12.0 

func (o LookupKeyResultOutput) Arn() pulumi.StringPtrOutput

func (LookupKeyResultOutput) Description added in v0.12.0 

func (o LookupKeyResultOutput) Description() pulumi.StringPtrOutput

A description of the AWS KMS key. Use a description that helps you to distinguish this AWS KMS key from others in the account, such as its intended use.

func (LookupKeyResultOutput) ElementType added in v0.12.0 

func (LookupKeyResultOutput) ElementType() reflect.Type

func (LookupKeyResultOutput) EnableKeyRotation added in v0.12.0 

func (o LookupKeyResultOutput) EnableKeyRotation() pulumi.BoolPtrOutput

Enables automatic rotation of the key material for the specified AWS KMS key. By default, automation key rotation is not enabled.

func (LookupKeyResultOutput) Enabled added in v0.12.0 

func (o LookupKeyResultOutput) Enabled() pulumi.BoolPtrOutput

Specifies whether the AWS KMS key is enabled. Disabled AWS KMS keys cannot be used in cryptographic operations.

func (LookupKeyResultOutput) KeyId added in v0.12.0 

func (o LookupKeyResultOutput) KeyId() pulumi.StringPtrOutput

func (LookupKeyResultOutput) KeyPolicy added in v0.12.0 

func (o LookupKeyResultOutput) KeyPolicy() pulumi.AnyOutput

The key policy that authorizes use of the AWS KMS key. The key policy must observe the following rules.

func (LookupKeyResultOutput) KeySpec added in v0.12.0 

func (o LookupKeyResultOutput) KeySpec() KeySpecPtrOutput

Specifies the type of AWS KMS key to create. The default value is SYMMETRIC_DEFAULT. This property is required only for asymmetric AWS KMS keys. You can't change the KeySpec value after the AWS KMS key is created.

func (LookupKeyResultOutput) KeyUsage added in v0.12.0 

func (o LookupKeyResultOutput) KeyUsage() KeyUsagePtrOutput

Determines the cryptographic operations for which you can use the AWS KMS key. The default value is ENCRYPT_DECRYPT. This property is required only for asymmetric AWS KMS keys. You can't change the KeyUsage value after the AWS KMS key is created.

func (LookupKeyResultOutput) MultiRegion added in v0.12.0 

func (o LookupKeyResultOutput) MultiRegion() pulumi.BoolPtrOutput

Specifies whether the AWS KMS key should be Multi-Region. You can't change the MultiRegion value after the AWS KMS key is created.

func (LookupKeyResultOutput) Origin added in v0.70.0 

func (o LookupKeyResultOutput) Origin() KeyOriginPtrOutput

The source of the key material for the KMS key. You cannot change the origin after you create the KMS key. The default is AWS_KMS, which means that AWS KMS creates the key material.

func (LookupKeyResultOutput) Tags added in v0.12.0 

func (o LookupKeyResultOutput) Tags() KeyTagArrayOutput

An array of key-value pairs to apply to this resource.

func (LookupKeyResultOutput) ToLookupKeyResultOutput added in v0.12.0 

func (o LookupKeyResultOutput) ToLookupKeyResultOutput() LookupKeyResultOutput

func (LookupKeyResultOutput) ToLookupKeyResultOutputWithContext added in v0.12.0 

func (o LookupKeyResultOutput) ToLookupKeyResultOutputWithContext(ctx context.Context) LookupKeyResultOutput

func (LookupKeyResultOutput) ToOutput added in v0.76.0 

func (o LookupKeyResultOutput) ToOutput(ctx context.Context) pulumix.Output[LookupKeyResult]

type LookupReplicaKeyArgs added in v0.12.0 

type LookupReplicaKeyArgs struct {
	KeyId string `pulumi:"keyId"`
}

type LookupReplicaKeyOutputArgs added in v0.12.0 

type LookupReplicaKeyOutputArgs struct {
	KeyId pulumi.StringInput `pulumi:"keyId"`
}

func (LookupReplicaKeyOutputArgs) ElementType added in v0.12.0 

func (LookupReplicaKeyOutputArgs) ElementType() reflect.Type

type LookupReplicaKeyResult added in v0.12.0 

type LookupReplicaKeyResult struct {
	Arn *string `pulumi:"arn"`
	// A description of the AWS KMS key. Use a description that helps you to distinguish this AWS KMS key from others in the account, such as its intended use.
	Description *string `pulumi:"description"`
	// Specifies whether the AWS KMS key is enabled. Disabled AWS KMS keys cannot be used in cryptographic operations.
	Enabled *bool   `pulumi:"enabled"`
	KeyId   *string `pulumi:"keyId"`
	// The key policy that authorizes use of the AWS KMS key. The key policy must observe the following rules.
	KeyPolicy interface{} `pulumi:"keyPolicy"`
	// An array of key-value pairs to apply to this resource.
	Tags []ReplicaKeyTag `pulumi:"tags"`
}

func LookupReplicaKey added in v0.12.0 

func LookupReplicaKey(ctx *pulumi.Context, args *LookupReplicaKeyArgs, opts ...pulumi.InvokeOption) (*LookupReplicaKeyResult, error)

The AWS::KMS::ReplicaKey resource specifies a multi-region replica AWS KMS key in AWS Key Management Service (AWS KMS).

type LookupReplicaKeyResultOutput added in v0.12.0 

type LookupReplicaKeyResultOutput struct{ *pulumi.OutputState }

func LookupReplicaKeyOutput added in v0.12.0 

func LookupReplicaKeyOutput(ctx *pulumi.Context, args LookupReplicaKeyOutputArgs, opts ...pulumi.InvokeOption) LookupReplicaKeyResultOutput

func (LookupReplicaKeyResultOutput) Arn added in v0.12.0 

func (o LookupReplicaKeyResultOutput) Arn() pulumi.StringPtrOutput

func (LookupReplicaKeyResultOutput) Description added in v0.12.0 

func (o LookupReplicaKeyResultOutput) Description() pulumi.StringPtrOutput

A description of the AWS KMS key. Use a description that helps you to distinguish this AWS KMS key from others in the account, such as its intended use.

func (LookupReplicaKeyResultOutput) ElementType added in v0.12.0 

func (LookupReplicaKeyResultOutput) ElementType() reflect.Type

func (LookupReplicaKeyResultOutput) Enabled added in v0.12.0 

func (o LookupReplicaKeyResultOutput) Enabled() pulumi.BoolPtrOutput

Specifies whether the AWS KMS key is enabled. Disabled AWS KMS keys cannot be used in cryptographic operations.

func (LookupReplicaKeyResultOutput) KeyId added in v0.12.0 

func (o LookupReplicaKeyResultOutput) KeyId() pulumi.StringPtrOutput

func (LookupReplicaKeyResultOutput) KeyPolicy added in v0.12.0 

func (o LookupReplicaKeyResultOutput) KeyPolicy() pulumi.AnyOutput

The key policy that authorizes use of the AWS KMS key. The key policy must observe the following rules.

func (LookupReplicaKeyResultOutput) Tags added in v0.12.0 

func (o LookupReplicaKeyResultOutput) Tags() ReplicaKeyTagArrayOutput

An array of key-value pairs to apply to this resource.

func (LookupReplicaKeyResultOutput) ToLookupReplicaKeyResultOutput added in v0.12.0 

func (o LookupReplicaKeyResultOutput) ToLookupReplicaKeyResultOutput() LookupReplicaKeyResultOutput

func (LookupReplicaKeyResultOutput) ToLookupReplicaKeyResultOutputWithContext added in v0.12.0 

func (o LookupReplicaKeyResultOutput) ToLookupReplicaKeyResultOutputWithContext(ctx context.Context) LookupReplicaKeyResultOutput

func (LookupReplicaKeyResultOutput) ToOutput added in v0.76.0 

func (o LookupReplicaKeyResultOutput) ToOutput(ctx context.Context) pulumix.Output[LookupReplicaKeyResult]

type ReplicaKey 

type ReplicaKey struct {
	pulumi.CustomResourceState

	Arn pulumi.StringOutput `pulumi:"arn"`
	// A description of the AWS KMS key. Use a description that helps you to distinguish this AWS KMS key from others in the account, such as its intended use.
	Description pulumi.StringPtrOutput `pulumi:"description"`
	// Specifies whether the AWS KMS key is enabled. Disabled AWS KMS keys cannot be used in cryptographic operations.
	Enabled pulumi.BoolPtrOutput `pulumi:"enabled"`
	KeyId   pulumi.StringOutput  `pulumi:"keyId"`
	// The key policy that authorizes use of the AWS KMS key. The key policy must observe the following rules.
	KeyPolicy pulumi.AnyOutput `pulumi:"keyPolicy"`
	// Specifies the number of days in the waiting period before AWS KMS deletes an AWS KMS key that has been removed from a CloudFormation stack. Enter a value between 7 and 30 days. The default value is 30 days.
	PendingWindowInDays pulumi.IntPtrOutput `pulumi:"pendingWindowInDays"`
	// Identifies the primary AWS KMS key to create a replica of. Specify the Amazon Resource Name (ARN) of the AWS KMS key. You cannot specify an alias or key ID. For help finding the ARN, see Finding the Key ID and ARN in the AWS Key Management Service Developer Guide.
	PrimaryKeyArn pulumi.StringOutput `pulumi:"primaryKeyArn"`
	// An array of key-value pairs to apply to this resource.
	Tags ReplicaKeyTagArrayOutput `pulumi:"tags"`
}

The AWS::KMS::ReplicaKey resource specifies a multi-region replica AWS KMS key in AWS Key Management Service (AWS KMS).

func GetReplicaKey 

func GetReplicaKey(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ReplicaKeyState, opts ...pulumi.ResourceOption) (*ReplicaKey, error)

GetReplicaKey gets an existing ReplicaKey resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewReplicaKey 

func NewReplicaKey(ctx *pulumi.Context,
	name string, args *ReplicaKeyArgs, opts ...pulumi.ResourceOption) (*ReplicaKey, error)

NewReplicaKey registers a new resource with the given unique name, arguments, and options.

func (*ReplicaKey) ElementType 

func (*ReplicaKey) ElementType() reflect.Type

func (*ReplicaKey) ToOutput added in v0.76.0 

func (i *ReplicaKey) ToOutput(ctx context.Context) pulumix.Output[*ReplicaKey]

func (*ReplicaKey) ToReplicaKeyOutput 

func (i *ReplicaKey) ToReplicaKeyOutput() ReplicaKeyOutput

func (*ReplicaKey) ToReplicaKeyOutputWithContext 

func (i *ReplicaKey) ToReplicaKeyOutputWithContext(ctx context.Context) ReplicaKeyOutput

type ReplicaKeyArgs 

type ReplicaKeyArgs struct {
	// A description of the AWS KMS key. Use a description that helps you to distinguish this AWS KMS key from others in the account, such as its intended use.
	Description pulumi.StringPtrInput
	// Specifies whether the AWS KMS key is enabled. Disabled AWS KMS keys cannot be used in cryptographic operations.
	Enabled pulumi.BoolPtrInput
	// The key policy that authorizes use of the AWS KMS key. The key policy must observe the following rules.
	KeyPolicy pulumi.Input
	// Specifies the number of days in the waiting period before AWS KMS deletes an AWS KMS key that has been removed from a CloudFormation stack. Enter a value between 7 and 30 days. The default value is 30 days.
	PendingWindowInDays pulumi.IntPtrInput
	// Identifies the primary AWS KMS key to create a replica of. Specify the Amazon Resource Name (ARN) of the AWS KMS key. You cannot specify an alias or key ID. For help finding the ARN, see Finding the Key ID and ARN in the AWS Key Management Service Developer Guide.
	PrimaryKeyArn pulumi.StringInput
	// An array of key-value pairs to apply to this resource.
	Tags ReplicaKeyTagArrayInput
}

The set of arguments for constructing a ReplicaKey resource.

func (ReplicaKeyArgs) ElementType 

func (ReplicaKeyArgs) ElementType() reflect.Type

type ReplicaKeyInput 

type ReplicaKeyInput interface {
	pulumi.Input

	ToReplicaKeyOutput() ReplicaKeyOutput
	ToReplicaKeyOutputWithContext(ctx context.Context) ReplicaKeyOutput
}

type ReplicaKeyOutput 

type ReplicaKeyOutput struct{ *pulumi.OutputState }

func (ReplicaKeyOutput) Arn added in v0.17.0 

func (o ReplicaKeyOutput) Arn() pulumi.StringOutput

func (ReplicaKeyOutput) Description added in v0.17.0 

func (o ReplicaKeyOutput) Description() pulumi.StringPtrOutput

A description of the AWS KMS key. Use a description that helps you to distinguish this AWS KMS key from others in the account, such as its intended use.

func (ReplicaKeyOutput) ElementType 

func (ReplicaKeyOutput) ElementType() reflect.Type

func (ReplicaKeyOutput) Enabled added in v0.17.0 

func (o ReplicaKeyOutput) Enabled() pulumi.BoolPtrOutput

Specifies whether the AWS KMS key is enabled. Disabled AWS KMS keys cannot be used in cryptographic operations.

func (ReplicaKeyOutput) KeyId added in v0.17.0 

func (o ReplicaKeyOutput) KeyId() pulumi.StringOutput

func (ReplicaKeyOutput) KeyPolicy added in v0.17.0 

func (o ReplicaKeyOutput) KeyPolicy() pulumi.AnyOutput

The key policy that authorizes use of the AWS KMS key. The key policy must observe the following rules.

func (ReplicaKeyOutput) PendingWindowInDays added in v0.17.0 

func (o ReplicaKeyOutput) PendingWindowInDays() pulumi.IntPtrOutput

Specifies the number of days in the waiting period before AWS KMS deletes an AWS KMS key that has been removed from a CloudFormation stack. Enter a value between 7 and 30 days. The default value is 30 days.

func (ReplicaKeyOutput) PrimaryKeyArn added in v0.17.0 

func (o ReplicaKeyOutput) PrimaryKeyArn() pulumi.StringOutput

Identifies the primary AWS KMS key to create a replica of. Specify the Amazon Resource Name (ARN) of the AWS KMS key. You cannot specify an alias or key ID. For help finding the ARN, see Finding the Key ID and ARN in the AWS Key Management Service Developer Guide.

func (ReplicaKeyOutput) Tags added in v0.17.0 

func (o ReplicaKeyOutput) Tags() ReplicaKeyTagArrayOutput

An array of key-value pairs to apply to this resource.

func (ReplicaKeyOutput) ToOutput added in v0.76.0 

func (o ReplicaKeyOutput) ToOutput(ctx context.Context) pulumix.Output[*ReplicaKey]

func (ReplicaKeyOutput) ToReplicaKeyOutput 

func (o ReplicaKeyOutput) ToReplicaKeyOutput() ReplicaKeyOutput

func (ReplicaKeyOutput) ToReplicaKeyOutputWithContext 

func (o ReplicaKeyOutput) ToReplicaKeyOutputWithContext(ctx context.Context) ReplicaKeyOutput

type ReplicaKeyState 

type ReplicaKeyState struct {
}

func (ReplicaKeyState) ElementType 

func (ReplicaKeyState) ElementType() reflect.Type

type ReplicaKeyTag 

type ReplicaKeyTag struct {
	// The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
	Key string `pulumi:"key"`
	// The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
	Value string `pulumi:"value"`
}

A key-value pair to associate with a resource.

type ReplicaKeyTagArgs 

type ReplicaKeyTagArgs struct {
	// The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
	Key pulumi.StringInput `pulumi:"key"`
	// The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
	Value pulumi.StringInput `pulumi:"value"`
}

A key-value pair to associate with a resource.

func (ReplicaKeyTagArgs) ElementType 

func (ReplicaKeyTagArgs) ElementType() reflect.Type

func (ReplicaKeyTagArgs) ToOutput added in v0.76.0 

func (i ReplicaKeyTagArgs) ToOutput(ctx context.Context) pulumix.Output[ReplicaKeyTag]

func (ReplicaKeyTagArgs) ToReplicaKeyTagOutput 

func (i ReplicaKeyTagArgs) ToReplicaKeyTagOutput() ReplicaKeyTagOutput

func (ReplicaKeyTagArgs) ToReplicaKeyTagOutputWithContext 

func (i ReplicaKeyTagArgs) ToReplicaKeyTagOutputWithContext(ctx context.Context) ReplicaKeyTagOutput

type ReplicaKeyTagArray 

type ReplicaKeyTagArray []ReplicaKeyTagInput

func (ReplicaKeyTagArray) ElementType 

func (ReplicaKeyTagArray) ElementType() reflect.Type

func (ReplicaKeyTagArray) ToOutput added in v0.76.0 

func (i ReplicaKeyTagArray) ToOutput(ctx context.Context) pulumix.Output[[]ReplicaKeyTag]

func (ReplicaKeyTagArray) ToReplicaKeyTagArrayOutput 

func (i ReplicaKeyTagArray) ToReplicaKeyTagArrayOutput() ReplicaKeyTagArrayOutput

func (ReplicaKeyTagArray) ToReplicaKeyTagArrayOutputWithContext 

func (i ReplicaKeyTagArray) ToReplicaKeyTagArrayOutputWithContext(ctx context.Context) ReplicaKeyTagArrayOutput

type ReplicaKeyTagArrayInput 

type ReplicaKeyTagArrayInput interface {
	pulumi.Input

	ToReplicaKeyTagArrayOutput() ReplicaKeyTagArrayOutput
	ToReplicaKeyTagArrayOutputWithContext(context.Context) ReplicaKeyTagArrayOutput
}

ReplicaKeyTagArrayInput is an input type that accepts ReplicaKeyTagArray and ReplicaKeyTagArrayOutput values. You can construct a concrete instance of `ReplicaKeyTagArrayInput` via: 

ReplicaKeyTagArray{ ReplicaKeyTagArgs{...} }

type ReplicaKeyTagArrayOutput 

type ReplicaKeyTagArrayOutput struct{ *pulumi.OutputState }

func (ReplicaKeyTagArrayOutput) ElementType 

func (ReplicaKeyTagArrayOutput) ElementType() reflect.Type

func (ReplicaKeyTagArrayOutput) Index 

func (o ReplicaKeyTagArrayOutput) Index(i pulumi.IntInput) ReplicaKeyTagOutput

func (ReplicaKeyTagArrayOutput) ToOutput added in v0.76.0 

func (o ReplicaKeyTagArrayOutput) ToOutput(ctx context.Context) pulumix.Output[[]ReplicaKeyTag]

func (ReplicaKeyTagArrayOutput) ToReplicaKeyTagArrayOutput 

func (o ReplicaKeyTagArrayOutput) ToReplicaKeyTagArrayOutput() ReplicaKeyTagArrayOutput

func (ReplicaKeyTagArrayOutput) ToReplicaKeyTagArrayOutputWithContext 

func (o ReplicaKeyTagArrayOutput) ToReplicaKeyTagArrayOutputWithContext(ctx context.Context) ReplicaKeyTagArrayOutput

type ReplicaKeyTagInput 

type ReplicaKeyTagInput interface {
	pulumi.Input

	ToReplicaKeyTagOutput() ReplicaKeyTagOutput
	ToReplicaKeyTagOutputWithContext(context.Context) ReplicaKeyTagOutput
}

ReplicaKeyTagInput is an input type that accepts ReplicaKeyTagArgs and ReplicaKeyTagOutput values. You can construct a concrete instance of `ReplicaKeyTagInput` via: 

ReplicaKeyTagArgs{...}

type ReplicaKeyTagOutput 

type ReplicaKeyTagOutput struct{ *pulumi.OutputState }

A key-value pair to associate with a resource.

func (ReplicaKeyTagOutput) ElementType 

func (ReplicaKeyTagOutput) ElementType() reflect.Type

func (ReplicaKeyTagOutput) Key 

func (o ReplicaKeyTagOutput) Key() pulumi.StringOutput

The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

func (ReplicaKeyTagOutput) ToOutput added in v0.76.0 

func (o ReplicaKeyTagOutput) ToOutput(ctx context.Context) pulumix.Output[ReplicaKeyTag]

func (ReplicaKeyTagOutput) ToReplicaKeyTagOutput 

func (o ReplicaKeyTagOutput) ToReplicaKeyTagOutput() ReplicaKeyTagOutput

func (ReplicaKeyTagOutput) ToReplicaKeyTagOutputWithContext 

func (o ReplicaKeyTagOutput) ToReplicaKeyTagOutputWithContext(ctx context.Context) ReplicaKeyTagOutput

func (ReplicaKeyTagOutput) Value 

func (o ReplicaKeyTagOutput) Value() pulumi.StringOutput

The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.