We recommend new projects start with resources from the AWS provider.
published on Monday, Sep 14, 2026 by Pulumi
We recommend new projects start with resources from the AWS provider.
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:
- Hsm
Type string - The type of HSM to use in the cluster.
- Backup
Retention Pulumi.Policy Aws Native. Cloud Hsm. Inputs. Backup Retention Policy Properties - A policy that defines how the service retains backups.
- Mode
Pulumi.
Aws Native. Cloud Hsm. Cluster Mode - The mode to use in the cluster.
- Network
Type Pulumi.Aws Native. Cloud Hsm. Cluster Network Type - 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.
-
List<Pulumi.
Aws Native. Inputs. Tag> - Tags to apply to the CloudHSM cluster.
- Hsm
Type string - The type of HSM to use in the cluster.
- Backup
Retention BackupPolicy Retention Policy Properties Args - A policy that defines how the service retains backups.
- Mode
Cluster
Mode - The mode to use in the cluster.
- Network
Type ClusterNetwork Type - The NetworkType to create a cluster with.
- Subnet
Ids []string - The identifiers (IDs) of the subnets where the cluster is created. You must specify at least one subnet.
-
Tag
Args - Tags to apply to the CloudHSM cluster.
- hsm_
type string - The type of HSM to use in the cluster.
- backup_
retention_ objectpolicy - 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.
- list(object)
- Tags to apply to the CloudHSM cluster.
- hsm
Type String - The type of HSM to use in the cluster.
- backup
Retention BackupPolicy Retention Policy Properties - A policy that defines how the service retains backups.
- mode
Cluster
Mode - The mode to use in the cluster.
- network
Type ClusterNetwork Type - 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.
- List<Tag>
- Tags to apply to the CloudHSM cluster.
- hsm
Type string - The type of HSM to use in the cluster.
- backup
Retention BackupPolicy Retention Policy Properties - A policy that defines how the service retains backups.
- mode
Cluster
Mode - The mode to use in the cluster.
- network
Type ClusterNetwork Type - The NetworkType to create a cluster with.
- subnet
Ids string[] - The identifiers (IDs) of the subnets where the cluster is created. You must specify at least one subnet.
- Tag[]
- Tags to apply to the CloudHSM cluster.
- hsm_
type str - The type of HSM to use in the cluster.
- backup_
retention_ Backuppolicy Retention Policy Properties Args - A policy that defines how the service retains backups.
- mode
Cluster
Mode - The mode to use in the cluster.
- network_
type ClusterNetwork Type - 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.
-
Sequence[Tag
Args] - Tags to apply to the CloudHSM cluster.
- hsm
Type String - The type of HSM to use in the cluster.
- backup
Retention Property MapPolicy - 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.
- 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.
- Backup
Policy Pulumi.Aws Native. Cloud Hsm. Cluster Backup Policy - 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
Pulumi.
Aws Native. Cloud Hsm. Cluster State - The cluster's state.
- Subnet
Mapping Dictionary<string, 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.
- Backup
Policy ClusterBackup Policy - 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
Cluster
State Enum - The cluster's state.
- Subnet
Mapping map[string]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.
- 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.
- backup
Policy ClusterBackup Policy - 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
Cluster
State - The cluster's state.
- subnet
Mapping Map<String,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.
- backup
Policy ClusterBackup Policy - 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
Cluster
State - The cluster's state.
- subnet
Mapping {[key: string]: 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 str
- The Amazon Resource Name (ARN) of the cluster.
- backup_
policy ClusterBackup Policy - 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
Cluster
State - 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.
- 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.
Supporting Types
BackupRetentionPolicyProperties, BackupRetentionPolicyPropertiesArgs
A policy that defines how the service retains backups.- Type
Pulumi.
Aws Native. Cloud Hsm. Cluster Backup Retention Policy Properties Type - The type of backup retention policy.
- Value string
- Use a value between 7 - 379.
- Type
Cluster
Backup Retention Policy Properties Type - The type of backup retention policy.
- Value string
- Use a value between 7 - 379.
- type
Cluster
Backup Retention Policy Properties Type - The type of backup retention policy.
- value String
- Use a value between 7 - 379.
- type
Cluster
Backup Retention Policy Properties Type - The type of backup retention policy.
- value string
- Use a value between 7 - 379.
- type
Cluster
Backup Retention Policy Properties Type - The type of backup retention policy.
- value str
- Use a value between 7 - 379.
ClusterBackupPolicy, ClusterBackupPolicyArgs
- Default
DEFAULT
- Cluster
Backup Policy Default DEFAULT
- "DEFAULT"
DEFAULT
- Default
DEFAULT
- Default
DEFAULT
- DEFAULT
DEFAULT
- "DEFAULT"
DEFAULT
ClusterBackupRetentionPolicyPropertiesType, ClusterBackupRetentionPolicyPropertiesTypeArgs
- Days
DAYS
- Cluster
Backup Retention Policy Properties Type Days DAYS
- "DAYS"
DAYS
- Days
DAYS
- Days
DAYS
- DAYS
DAYS
- "DAYS"
DAYS
ClusterMode, ClusterModeArgs
- Fips
FIPS- Non
Fips NON_FIPS
- Cluster
Mode Fips FIPS- Cluster
Mode Non Fips NON_FIPS
- "FIPS"
FIPS- "NON_FIPS"
NON_FIPS
- Fips
FIPS- Non
Fips NON_FIPS
- Fips
FIPS- Non
Fips NON_FIPS
- FIPS
FIPS- NON_FIPS
NON_FIPS
- "FIPS"
FIPS- "NON_FIPS"
NON_FIPS
ClusterNetworkType, ClusterNetworkTypeArgs
- Ipv4
IPV4- Dualstack
DUALSTACK
- Cluster
Network Type Ipv4 IPV4- Cluster
Network Type Dualstack DUALSTACK
- "IPV4"
IPV4- "DUALSTACK"
DUALSTACK
- Ipv4
IPV4- Dualstack
DUALSTACK
- Ipv4
IPV4- Dualstack
DUALSTACK
- IPV4
IPV4- DUALSTACK
DUALSTACK
- "IPV4"
IPV4- "DUALSTACK"
DUALSTACK
ClusterState, ClusterStateArgs
- 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
- Cluster
State Create In Progress CREATE_IN_PROGRESS- Cluster
State Uninitialized UNINITIALIZED- Cluster
State Initialize In Progress INITIALIZE_IN_PROGRESS- Cluster
State Initialized INITIALIZED- Cluster
State Active ACTIVE- Cluster
State Update In Progress UPDATE_IN_PROGRESS- Cluster
State Modify In Progress MODIFY_IN_PROGRESS- Cluster
State Rollback In Progress ROLLBACK_IN_PROGRESS- Cluster
State Delete In Progress DELETE_IN_PROGRESS- Cluster
State Deleted DELETED- Cluster
State 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
- 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
- "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.Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.
published on Monday, Sep 14, 2026 by Pulumi