Package software.amazon.awscdk.services.cloudhsm

Interface CfnClusterProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnClusterProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.139.0 (build 26a6b54)",
           date="2026-09-02T11:03:05.693Z")
@Stability(Stable)
public interface CfnClusterProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnCluster.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.cloudhsm.*;
 CfnClusterProps cfnClusterProps = CfnClusterProps.builder()
         .hsmType("hsmType")
         // the properties below are optional
         .backupRetentionPolicy(BackupRetentionPolicyProperty.builder()
                 .type("type")
                 .value("value")
                 .build())
         .mode("mode")
         .networkType("networkType")
         .subnetIds(List.of("subnetIds"))
         .tags(List.of(TagsItemsProperty.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudhsm-cluster.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnClusterProps.Builder	A builder for CfnClusterProps
static final class	CfnClusterProps.Jsii$Proxy	An implementation for CfnClusterProps

Method Summary

Modifier and Type	Method	Description
static CfnClusterProps.Builder	builder()
default Object	getBackupRetentionPolicy()	A policy that defines how the service retains backups.
String	getHsmType()	The type of HSM to use in the cluster.
default String	getMode()	The mode to use in the cluster.
default String	getNetworkType()	The NetworkType to create a cluster with.
default List<String>	getSubnetIds()	The identifiers (IDs) of the subnets where the cluster is created.
default List<CfnCluster.TagsItemsProperty>	getTags()	Tags to apply to the CloudHSM cluster.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getHsmType

@Stability(Stable)
@NotNull
String getHsmType()

The type of HSM to use in the cluster.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudhsm-cluster.html#cfn-cloudhsm-cluster-hsmtype

getBackupRetentionPolicy

@Stability(Stable)
@Nullable
default Object getBackupRetentionPolicy()

A policy that defines how the service retains backups.

Returns union: either IResolvable or CfnCluster.BackupRetentionPolicyProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudhsm-cluster.html#cfn-cloudhsm-cluster-backupretentionpolicy

getMode

@Stability(Stable)
@Nullable
default String getMode()

The mode to use in the cluster.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudhsm-cluster.html#cfn-cloudhsm-cluster-mode

getNetworkType

@Stability(Stable)
@Nullable
default String getNetworkType()

The NetworkType to create a cluster with.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudhsm-cluster.html#cfn-cloudhsm-cluster-networktype

getSubnetIds

@Stability(Stable)
@Nullable
default List<String> getSubnetIds()

The identifiers (IDs) of the subnets where the cluster is created.

You must specify at least one subnet.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudhsm-cluster.html#cfn-cloudhsm-cluster-subnetids

getTags

@Stability(Stable)
@Nullable
default List<CfnCluster.TagsItemsProperty> getTags()

Tags to apply to the CloudHSM cluster.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudhsm-cluster.html#cfn-cloudhsm-cluster-tags

builder

@Stability(Stable)
static CfnClusterProps.Builder builder()

Returns:

a CfnClusterProps.Builder of CfnClusterProps