ReplicaKey

class ReplicaKey : KotlinCustomResource

Manages a KMS multi-Region replica key.

Example Usage

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.Provider;
import com.pulumi.aws.ProviderArgs;
import com.pulumi.aws.kms.Key;
import com.pulumi.aws.kms.KeyArgs;
import com.pulumi.aws.kms.ReplicaKey;
import com.pulumi.aws.kms.ReplicaKeyArgs;
import com.pulumi.resources.CustomResourceOptions;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var primary = new Provider("primary", ProviderArgs.builder()
.region("us-east-1")
.build());
var primaryKey = new Key("primaryKey", KeyArgs.builder()
.description("Multi-Region primary key")
.deletionWindowInDays(30)
.multiRegion(true)
.build(), CustomResourceOptions.builder()
.provider(aws.primary())
.build());
var replica = new ReplicaKey("replica", ReplicaKeyArgs.builder()
.description("Multi-Region replica key")
.deletionWindowInDays(7)
.primaryKeyArn(primaryKey.arn())
.build());
}
}

Import

KMS multi-Region replica keys can be imported using the id, e.g.,

$ pulumi import aws:kms/replicaKey:ReplicaKey example 1234abcd-12ab-34cd-56ef-1234567890ab

Properties

Link copied to clipboard
val arn: Output<String>

The Amazon Resource Name (ARN) of the replica key. The key ARNs of related multi-Region keys differ only in the Region value.

Link copied to clipboard

A flag to indicate whether to bypass the key policy lockout safety check. Setting this value to true increases the risk that the KMS key becomes unmanageable. Do not set this value to true indiscriminately. For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide. The default value is false.

Link copied to clipboard

The waiting period, specified in number of days. After the waiting period ends, AWS KMS deletes the KMS key. If you specify a value, it must be between 7 and 30, inclusive. If you do not specify a value, it defaults to 30.

Link copied to clipboard
val description: Output<String>?

A description of the KMS key.

Link copied to clipboard
val enabled: Output<Boolean>?

Specifies whether the replica key is enabled. Disabled KMS keys cannot be used in cryptographic operations. The default value is true.

Link copied to clipboard
val id: Output<String>
Link copied to clipboard
val keyId: Output<String>

The key ID of the replica key. Related multi-Region keys have the same key ID.

Link copied to clipboard

A Boolean value that specifies whether key rotation is enabled. This is a shared property of multi-Region keys.

Link copied to clipboard
val keySpec: Output<String>

The type of key material in the KMS key. This is a shared property of multi-Region keys.

Link copied to clipboard
val keyUsage: Output<String>

The cryptographic operations for which you can use the KMS key. This is a shared property of multi-Region keys.

Link copied to clipboard
val policy: Output<String>

The key policy to attach to the KMS key. If you do not specify a key policy, AWS KMS attaches the default key policy to the KMS key.

Link copied to clipboard
val primaryKeyArn: Output<String>

The ARN of the multi-Region primary key to replicate. The primary key must be in a different AWS Region of the same AWS Partition. You can create only one replica of a given primary key in each AWS Region.

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val tags: Output<Map<String, String>>?

A map of tags to assign to the replica key. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

Link copied to clipboard
val tagsAll: Output<Map<String, String>>

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Link copied to clipboard
val urn: Output<String>