1. Registry
  2. Packages
  3. AWS Cloud Control
  4. API Docs
  5. cloudhsm
  6. Cluster

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.79.0
published on Monday, Sep 14, 2026 by Pulumi
aws-native logo aws-native logo

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.79.0
published on Monday, Sep 14, 2026 by Pulumi

    Creates and manages an AWS CloudHSM cluster.

    Create Cluster Resource

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

    Constructor syntax

    new Cluster(name: string, args: ClusterArgs, opts?: CustomResourceOptions);
    @overload
    def Cluster(resource_name: str,
                args: ClusterArgs,
                opts: Optional[ResourceOptions] = None)
    
    @overload
    def Cluster(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                hsm_type: Optional[str] = None,
                backup_retention_policy: Optional[BackupRetentionPolicyPropertiesArgs] = None,
                mode: Optional[ClusterMode] = None,
                network_type: Optional[ClusterNetworkType] = None,
                subnet_ids: Optional[Sequence[str]] = None,
                tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
    func NewCluster(ctx *Context, name string, args ClusterArgs, opts ...ResourceOption) (*Cluster, error)
    public Cluster(string name, ClusterArgs args, CustomResourceOptions? opts = null)
    public Cluster(String name, ClusterArgs args)
    public Cluster(String name, ClusterArgs args, CustomResourceOptions options)
    
    type: aws-native:cloudhsm:Cluster
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "aws-native_cloudhsm_cluster" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args ClusterArgs
    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 ClusterArgs
    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 ClusterArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ClusterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ClusterArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

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

    HsmType string
    The type of HSM to use in the cluster.
    BackupRetentionPolicy Pulumi.AwsNative.CloudHsm.Inputs.BackupRetentionPolicyProperties
    A policy that defines how the service retains backups.
    Mode Pulumi.AwsNative.CloudHsm.ClusterMode
    The mode to use in the cluster.
    NetworkType Pulumi.AwsNative.CloudHsm.ClusterNetworkType
    The NetworkType to create a cluster with.
    SubnetIds List<string>
    The identifiers (IDs) of the subnets where the cluster is created. You must specify at least one subnet.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    Tags to apply to the CloudHSM cluster.
    HsmType string
    The type of HSM to use in the cluster.
    BackupRetentionPolicy BackupRetentionPolicyPropertiesArgs
    A policy that defines how the service retains backups.
    Mode ClusterMode
    The mode to use in the cluster.
    NetworkType ClusterNetworkType
    The NetworkType to create a cluster with.
    SubnetIds []string
    The identifiers (IDs) of the subnets where the cluster is created. You must specify at least one subnet.
    Tags TagArgs
    Tags to apply to the CloudHSM cluster.
    hsm_type string
    The type of HSM to use in the cluster.
    backup_retention_policy object
    A policy that defines how the service retains backups.
    mode "FIPS" | "NON_FIPS"
    The mode to use in the cluster.
    network_type "IPV4" | "DUALSTACK"
    The NetworkType to create a cluster with.
    subnet_ids list(string)
    The identifiers (IDs) of the subnets where the cluster is created. You must specify at least one subnet.
    tags list(object)
    Tags to apply to the CloudHSM cluster.
    hsmType String
    The type of HSM to use in the cluster.
    backupRetentionPolicy BackupRetentionPolicyProperties
    A policy that defines how the service retains backups.
    mode ClusterMode
    The mode to use in the cluster.
    networkType ClusterNetworkType
    The NetworkType to create a cluster with.
    subnetIds List<String>
    The identifiers (IDs) of the subnets where the cluster is created. You must specify at least one subnet.
    tags List<Tag>
    Tags to apply to the CloudHSM cluster.
    hsmType string
    The type of HSM to use in the cluster.
    backupRetentionPolicy BackupRetentionPolicyProperties
    A policy that defines how the service retains backups.
    mode ClusterMode
    The mode to use in the cluster.
    networkType ClusterNetworkType
    The NetworkType to create a cluster with.
    subnetIds string[]
    The identifiers (IDs) of the subnets where the cluster is created. You must specify at least one subnet.
    tags Tag[]
    Tags to apply to the CloudHSM cluster.
    hsm_type str
    The type of HSM to use in the cluster.
    backup_retention_policy BackupRetentionPolicyPropertiesArgs
    A policy that defines how the service retains backups.
    mode ClusterMode
    The mode to use in the cluster.
    network_type ClusterNetworkType
    The NetworkType to create a cluster with.
    subnet_ids Sequence[str]
    The identifiers (IDs) of the subnets where the cluster is created. You must specify at least one subnet.
    tags Sequence[TagArgs]
    Tags to apply to the CloudHSM cluster.
    hsmType String
    The type of HSM to use in the cluster.
    backupRetentionPolicy Property Map
    A policy that defines how the service retains backups.
    mode "FIPS" | "NON_FIPS"
    The mode to use in the cluster.
    networkType "IPV4" | "DUALSTACK"
    The NetworkType to create a cluster with.
    subnetIds List<String>
    The identifiers (IDs) of the subnets where the cluster is created. You must specify at least one subnet.
    tags List<Property Map>
    Tags to apply to the CloudHSM cluster.

    Outputs

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

    Arn string
    The Amazon Resource Name (ARN) of the cluster.
    BackupPolicy Pulumi.AwsNative.CloudHsm.ClusterBackupPolicy
    The cluster's backup policy.
    ClusterId string
    The cluster's identifier (ID).
    Id string
    The provider-assigned unique ID for this managed resource.
    SecurityGroup string
    The identifier (ID) of the cluster's security group.
    State Pulumi.AwsNative.CloudHsm.ClusterState
    The cluster's state.
    SubnetMapping Dictionary<string, string>
    A map from availability zone to the cluster's subnet in that availability zone.
    VpcId string
    The identifier (ID) of the virtual private cloud (VPC) that contains the cluster.
    Arn string
    The Amazon Resource Name (ARN) of the cluster.
    BackupPolicy ClusterBackupPolicy
    The cluster's backup policy.
    ClusterId string
    The cluster's identifier (ID).
    Id string
    The provider-assigned unique ID for this managed resource.
    SecurityGroup string
    The identifier (ID) of the cluster's security group.
    State ClusterStateEnum
    The cluster's state.
    SubnetMapping map[string]string
    A map from availability zone to the cluster's subnet in that availability zone.
    VpcId string
    The identifier (ID) of the virtual private cloud (VPC) that contains the cluster.
    arn string
    The Amazon Resource Name (ARN) of the cluster.
    backup_policy "DEFAULT"
    The cluster's backup policy.
    cluster_id string
    The cluster's identifier (ID).
    id string
    The provider-assigned unique ID for this managed resource.
    security_group string
    The identifier (ID) of the cluster's security group.
    state "CREATE_IN_PROGRESS" | "UNINITIALIZED" | "INITIALIZE_IN_PROGRESS" | "INITIALIZED" | "ACTIVE" | "UPDATE_IN_PROGRESS" | "MODIFY_IN_PROGRESS" | "ROLLBACK_IN_PROGRESS" | "DELETE_IN_PROGRESS" | "DELETED" | "DEGRADED"
    The cluster's state.
    subnet_mapping map(string)
    A map from availability zone to the cluster's subnet in that availability zone.
    vpc_id string
    The identifier (ID) of the virtual private cloud (VPC) that contains the cluster.
    arn String
    The Amazon Resource Name (ARN) of the cluster.
    backupPolicy ClusterBackupPolicy
    The cluster's backup policy.
    clusterId String
    The cluster's identifier (ID).
    id String
    The provider-assigned unique ID for this managed resource.
    securityGroup String
    The identifier (ID) of the cluster's security group.
    state ClusterState
    The cluster's state.
    subnetMapping Map<String,String>
    A map from availability zone to the cluster's subnet in that availability zone.
    vpcId String
    The identifier (ID) of the virtual private cloud (VPC) that contains the cluster.
    arn string
    The Amazon Resource Name (ARN) of the cluster.
    backupPolicy ClusterBackupPolicy
    The cluster's backup policy.
    clusterId string
    The cluster's identifier (ID).
    id string
    The provider-assigned unique ID for this managed resource.
    securityGroup string
    The identifier (ID) of the cluster's security group.
    state ClusterState
    The cluster's state.
    subnetMapping {[key: string]: string}
    A map from availability zone to the cluster's subnet in that availability zone.
    vpcId string
    The identifier (ID) of the virtual private cloud (VPC) that contains the cluster.
    arn str
    The Amazon Resource Name (ARN) of the cluster.
    backup_policy ClusterBackupPolicy
    The cluster's backup policy.
    cluster_id str
    The cluster's identifier (ID).
    id str
    The provider-assigned unique ID for this managed resource.
    security_group str
    The identifier (ID) of the cluster's security group.
    state ClusterState
    The cluster's state.
    subnet_mapping Mapping[str, str]
    A map from availability zone to the cluster's subnet in that availability zone.
    vpc_id str
    The identifier (ID) of the virtual private cloud (VPC) that contains the cluster.
    arn String
    The Amazon Resource Name (ARN) of the cluster.
    backupPolicy "DEFAULT"
    The cluster's backup policy.
    clusterId String
    The cluster's identifier (ID).
    id String
    The provider-assigned unique ID for this managed resource.
    securityGroup String
    The identifier (ID) of the cluster's security group.
    state "CREATE_IN_PROGRESS" | "UNINITIALIZED" | "INITIALIZE_IN_PROGRESS" | "INITIALIZED" | "ACTIVE" | "UPDATE_IN_PROGRESS" | "MODIFY_IN_PROGRESS" | "ROLLBACK_IN_PROGRESS" | "DELETE_IN_PROGRESS" | "DELETED" | "DEGRADED"
    The cluster's state.
    subnetMapping Map<String>
    A map from availability zone to the cluster's subnet in that availability zone.
    vpcId String
    The identifier (ID) of the virtual private cloud (VPC) that contains the cluster.

    Supporting Types

    BackupRetentionPolicyProperties, BackupRetentionPolicyPropertiesArgs

    A policy that defines how the service retains backups.
    Type Pulumi.AwsNative.CloudHsm.ClusterBackupRetentionPolicyPropertiesType
    The type of backup retention policy.
    Value string
    Use a value between 7 - 379.
    Type ClusterBackupRetentionPolicyPropertiesType
    The type of backup retention policy.
    Value string
    Use a value between 7 - 379.
    type "DAYS"
    The type of backup retention policy.
    value string
    Use a value between 7 - 379.
    type ClusterBackupRetentionPolicyPropertiesType
    The type of backup retention policy.
    value String
    Use a value between 7 - 379.
    type ClusterBackupRetentionPolicyPropertiesType
    The type of backup retention policy.
    value string
    Use a value between 7 - 379.
    type ClusterBackupRetentionPolicyPropertiesType
    The type of backup retention policy.
    value str
    Use a value between 7 - 379.
    type "DAYS"
    The type of backup retention policy.
    value String
    Use a value between 7 - 379.

    ClusterBackupPolicy, ClusterBackupPolicyArgs

    Default
    DEFAULT
    ClusterBackupPolicyDefault
    DEFAULT
    "DEFAULT"
    DEFAULT
    Default
    DEFAULT
    Default
    DEFAULT
    DEFAULT
    DEFAULT
    "DEFAULT"
    DEFAULT

    ClusterBackupRetentionPolicyPropertiesType, ClusterBackupRetentionPolicyPropertiesTypeArgs

    Days
    DAYS
    ClusterBackupRetentionPolicyPropertiesTypeDays
    DAYS
    "DAYS"
    DAYS
    Days
    DAYS
    Days
    DAYS
    DAYS
    DAYS
    "DAYS"
    DAYS

    ClusterMode, ClusterModeArgs

    Fips
    FIPS
    NonFips
    NON_FIPS
    ClusterModeFips
    FIPS
    ClusterModeNonFips
    NON_FIPS
    "FIPS"
    FIPS
    "NON_FIPS"
    NON_FIPS
    Fips
    FIPS
    NonFips
    NON_FIPS
    Fips
    FIPS
    NonFips
    NON_FIPS
    FIPS
    FIPS
    NON_FIPS
    NON_FIPS
    "FIPS"
    FIPS
    "NON_FIPS"
    NON_FIPS

    ClusterNetworkType, ClusterNetworkTypeArgs

    Ipv4
    IPV4
    Dualstack
    DUALSTACK
    ClusterNetworkTypeIpv4
    IPV4
    ClusterNetworkTypeDualstack
    DUALSTACK
    "IPV4"
    IPV4
    "DUALSTACK"
    DUALSTACK
    Ipv4
    IPV4
    Dualstack
    DUALSTACK
    Ipv4
    IPV4
    Dualstack
    DUALSTACK
    IPV4
    IPV4
    DUALSTACK
    DUALSTACK
    "IPV4"
    IPV4
    "DUALSTACK"
    DUALSTACK

    ClusterState, ClusterStateArgs

    CreateInProgress
    CREATE_IN_PROGRESS
    Uninitialized
    UNINITIALIZED
    InitializeInProgress
    INITIALIZE_IN_PROGRESS
    Initialized
    INITIALIZED
    Active
    ACTIVE
    UpdateInProgress
    UPDATE_IN_PROGRESS
    ModifyInProgress
    MODIFY_IN_PROGRESS
    RollbackInProgress
    ROLLBACK_IN_PROGRESS
    DeleteInProgress
    DELETE_IN_PROGRESS
    Deleted
    DELETED
    Degraded
    DEGRADED
    ClusterStateCreateInProgress
    CREATE_IN_PROGRESS
    ClusterStateUninitialized
    UNINITIALIZED
    ClusterStateInitializeInProgress
    INITIALIZE_IN_PROGRESS
    ClusterStateInitialized
    INITIALIZED
    ClusterStateActive
    ACTIVE
    ClusterStateUpdateInProgress
    UPDATE_IN_PROGRESS
    ClusterStateModifyInProgress
    MODIFY_IN_PROGRESS
    ClusterStateRollbackInProgress
    ROLLBACK_IN_PROGRESS
    ClusterStateDeleteInProgress
    DELETE_IN_PROGRESS
    ClusterStateDeleted
    DELETED
    ClusterStateDegraded
    DEGRADED
    "CREATE_IN_PROGRESS"
    CREATE_IN_PROGRESS
    "UNINITIALIZED"
    UNINITIALIZED
    "INITIALIZE_IN_PROGRESS"
    INITIALIZE_IN_PROGRESS
    "INITIALIZED"
    INITIALIZED
    "ACTIVE"
    ACTIVE
    "UPDATE_IN_PROGRESS"
    UPDATE_IN_PROGRESS
    "MODIFY_IN_PROGRESS"
    MODIFY_IN_PROGRESS
    "ROLLBACK_IN_PROGRESS"
    ROLLBACK_IN_PROGRESS
    "DELETE_IN_PROGRESS"
    DELETE_IN_PROGRESS
    "DELETED"
    DELETED
    "DEGRADED"
    DEGRADED
    CreateInProgress
    CREATE_IN_PROGRESS
    Uninitialized
    UNINITIALIZED
    InitializeInProgress
    INITIALIZE_IN_PROGRESS
    Initialized
    INITIALIZED
    Active
    ACTIVE
    UpdateInProgress
    UPDATE_IN_PROGRESS
    ModifyInProgress
    MODIFY_IN_PROGRESS
    RollbackInProgress
    ROLLBACK_IN_PROGRESS
    DeleteInProgress
    DELETE_IN_PROGRESS
    Deleted
    DELETED
    Degraded
    DEGRADED
    CreateInProgress
    CREATE_IN_PROGRESS
    Uninitialized
    UNINITIALIZED
    InitializeInProgress
    INITIALIZE_IN_PROGRESS
    Initialized
    INITIALIZED
    Active
    ACTIVE
    UpdateInProgress
    UPDATE_IN_PROGRESS
    ModifyInProgress
    MODIFY_IN_PROGRESS
    RollbackInProgress
    ROLLBACK_IN_PROGRESS
    DeleteInProgress
    DELETE_IN_PROGRESS
    Deleted
    DELETED
    Degraded
    DEGRADED
    CREATE_IN_PROGRESS
    CREATE_IN_PROGRESS
    UNINITIALIZED
    UNINITIALIZED
    INITIALIZE_IN_PROGRESS
    INITIALIZE_IN_PROGRESS
    INITIALIZED
    INITIALIZED
    ACTIVE
    ACTIVE
    UPDATE_IN_PROGRESS
    UPDATE_IN_PROGRESS
    MODIFY_IN_PROGRESS
    MODIFY_IN_PROGRESS
    ROLLBACK_IN_PROGRESS
    ROLLBACK_IN_PROGRESS
    DELETE_IN_PROGRESS
    DELETE_IN_PROGRESS
    DELETED
    DELETED
    DEGRADED
    DEGRADED
    "CREATE_IN_PROGRESS"
    CREATE_IN_PROGRESS
    "UNINITIALIZED"
    UNINITIALIZED
    "INITIALIZE_IN_PROGRESS"
    INITIALIZE_IN_PROGRESS
    "INITIALIZED"
    INITIALIZED
    "ACTIVE"
    ACTIVE
    "UPDATE_IN_PROGRESS"
    UPDATE_IN_PROGRESS
    "MODIFY_IN_PROGRESS"
    MODIFY_IN_PROGRESS
    "ROLLBACK_IN_PROGRESS"
    ROLLBACK_IN_PROGRESS
    "DELETE_IN_PROGRESS"
    DELETE_IN_PROGRESS
    "DELETED"
    DELETED
    "DEGRADED"
    DEGRADED

    Tag, TagArgs

    A set of tags to apply to the resource.
    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo aws-native logo

    We recommend new projects start with resources from the AWS provider.

    Viewing docs for AWS Cloud Control v1.79.0
    published on Monday, Sep 14, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial