Class CfnCluster

Creates and manages an AWS CloudHSM cluster.

Inheritance
object
CfnElement
CfnRefElement
CfnResource
CfnCluster
Implements
IConstruct
IDependable
Inherited Members
Namespace: Amazon.CDK.AWS.CloudHSM
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnCluster : CfnResource, IInspectable, IClusterRef, IConstruct, IDependable, IEnvironmentAware, ITaggableV2
Syntax (vb)
Public Class CfnCluster Inherits CfnResource Implements IInspectable, IClusterRef, IConstruct, IDependable, IEnvironmentAware, ITaggableV2
Remarks

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

CloudformationResource: AWS::CloudHSM::Cluster

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.CloudHSM;

             var cfnCluster = new CfnCluster(this, "MyCfnCluster", new CfnClusterProps {
                 HsmType = "hsmType",

                 // the properties below are optional
                 BackupRetentionPolicy = new BackupRetentionPolicyProperty {
                     Type = "type",
                     Value = "value"
                 },
                 Mode = "mode",
                 NetworkType = "networkType",
                 SubnetIds = new [] { "subnetIds" },
                 Tags = new [] { new TagsItemsProperty {
                     Key = "key",
                     Value = "value"
                 } }
             });

Synopsis

Constructors

CfnCluster(Construct, string, ICfnClusterProps)

Create a new AWS::CloudHSM::Cluster.

Properties

AttrArn

The Amazon Resource Name (ARN) of the cluster.
AttrBackupPolicy

The cluster's backup policy.
AttrClusterId

The cluster's identifier (ID).
AttrSecurityGroup

The identifier (ID) of the cluster's security group.
AttrState

The cluster's state.
AttrSubnetMapping

A map from availability zone to the cluster's subnet in that availability zone.
AttrVpcId

The identifier (ID) of the virtual private cloud (VPC) that contains the cluster.
BackupRetentionPolicy

A policy that defines how the service retains backups.
CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.
CdkTagManager

Tag Manager which manages the tags for this resource.
CfnProperties

Creates and manages an AWS CloudHSM cluster.
CfnPropertyNames

Creates and manages an AWS CloudHSM cluster.
ClusterRef

A reference to a Cluster resource.
HsmType

The type of HSM to use in the cluster.
Mode

The mode to use in the cluster.
NetworkType

The NetworkType to create a cluster with.
SubnetIds

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

Tags to apply to the CloudHSM cluster.

Methods

ArnForCluster(IClusterRef)

Creates and manages an AWS CloudHSM cluster.
Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.
IsCfnCluster(object)

Checks whether the given object is a CfnCluster.
RenderProperties(IDictionary<string, object>)

Creates and manages an AWS CloudHSM cluster.

Constructors

CfnCluster(Construct, string, ICfnClusterProps)

Create a new AWS::CloudHSM::Cluster.

public CfnCluster(Construct scope, string id, ICfnClusterProps props)
Parameters
scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnClusterProps

Resource properties.

Remarks

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

CloudformationResource: AWS::CloudHSM::Cluster

ExampleMetadata: fixture=_generated

Properties

AttrArn

The Amazon Resource Name (ARN) of the cluster.

public virtual string AttrArn { get; }
Property Value

string

Remarks

CloudformationAttribute: Arn

AttrBackupPolicy

The cluster's backup policy.

public virtual string AttrBackupPolicy { get; }
Property Value

string

Remarks

CloudformationAttribute: BackupPolicy

AttrClusterId

The cluster's identifier (ID).

public virtual string AttrClusterId { get; }
Property Value

string

Remarks

CloudformationAttribute: ClusterId

AttrSecurityGroup

The identifier (ID) of the cluster's security group.

public virtual string AttrSecurityGroup { get; }
Property Value

string

Remarks

CloudformationAttribute: SecurityGroup

AttrState

The cluster's state.

public virtual string AttrState { get; }
Property Value

string

Remarks

CloudformationAttribute: State

AttrSubnetMapping

A map from availability zone to the cluster's subnet in that availability zone.

public virtual IResolvable AttrSubnetMapping { get; }
Property Value

IResolvable

Remarks

CloudformationAttribute: SubnetMapping

AttrVpcId

The identifier (ID) of the virtual private cloud (VPC) that contains the cluster.

public virtual string AttrVpcId { get; }
Property Value

string

Remarks

CloudformationAttribute: VpcId

BackupRetentionPolicy

A policy that defines how the service retains backups.

public virtual object? BackupRetentionPolicy { get; set; }
Property Value

object

Remarks

Type union: either IResolvable or CfnCluster.IBackupRetentionPolicyProperty

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value

string

Remarks

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

CloudformationResource: AWS::CloudHSM::Cluster

ExampleMetadata: fixture=_generated

CdkTagManager

Tag Manager which manages the tags for this resource.

public virtual TagManager CdkTagManager { get; }
Property Value

TagManager

Remarks

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

CloudformationResource: AWS::CloudHSM::Cluster

ExampleMetadata: fixture=_generated

CfnProperties

Creates and manages an AWS CloudHSM cluster.

protected override IDictionary<string, object> CfnProperties { get; }
Property Value

IDictionary<string, object>

Overrides
Remarks

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

CloudformationResource: AWS::CloudHSM::Cluster

ExampleMetadata: fixture=_generated

CfnPropertyNames

Creates and manages an AWS CloudHSM cluster.

protected override IDictionary<string, string> CfnPropertyNames { get; }
Property Value

IDictionary<string, string>

Overrides
Remarks

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

CloudformationResource: AWS::CloudHSM::Cluster

ExampleMetadata: fixture=_generated

ClusterRef

A reference to a Cluster resource.

public virtual IClusterReference ClusterRef { get; }
Property Value

IClusterReference

Remarks

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

CloudformationResource: AWS::CloudHSM::Cluster

ExampleMetadata: fixture=_generated

HsmType

The type of HSM to use in the cluster.

public virtual string HsmType { get; set; }
Property Value

string

Remarks

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

CloudformationResource: AWS::CloudHSM::Cluster

ExampleMetadata: fixture=_generated

Mode

The mode to use in the cluster.

public virtual string? Mode { get; set; }
Property Value

string

Remarks

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

CloudformationResource: AWS::CloudHSM::Cluster

ExampleMetadata: fixture=_generated

NetworkType

The NetworkType to create a cluster with.

public virtual string? NetworkType { get; set; }
Property Value

string

Remarks

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

CloudformationResource: AWS::CloudHSM::Cluster

ExampleMetadata: fixture=_generated

SubnetIds

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

public virtual string[]? SubnetIds { get; set; }
Property Value

string[]

Remarks

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

CloudformationResource: AWS::CloudHSM::Cluster

ExampleMetadata: fixture=_generated

Tags

Tags to apply to the CloudHSM cluster.

public virtual CfnCluster.ITagsItemsProperty[]? Tags { get; set; }
Property Value

ITagsItemsProperty[]

Remarks

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

CloudformationResource: AWS::CloudHSM::Cluster

ExampleMetadata: fixture=_generated

Methods

ArnForCluster(IClusterRef)

Creates and manages an AWS CloudHSM cluster.

public static string ArnForCluster(IClusterRef resource)
Parameters
resource IClusterRef
Returns

string

Remarks

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

CloudformationResource: AWS::CloudHSM::Cluster

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.CloudHSM;

             var cfnCluster = new CfnCluster(this, "MyCfnCluster", new CfnClusterProps {
                 HsmType = "hsmType",

                 // the properties below are optional
                 BackupRetentionPolicy = new BackupRetentionPolicyProperty {
                     Type = "type",
                     Value = "value"
                 },
                 Mode = "mode",
                 NetworkType = "networkType",
                 SubnetIds = new [] { "subnetIds" },
                 Tags = new [] { new TagsItemsProperty {
                     Key = "key",
                     Value = "value"
                 } }
             });

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)
Parameters
inspector TreeInspector

tree inspector to collect and process attributes.

Remarks

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

CloudformationResource: AWS::CloudHSM::Cluster

ExampleMetadata: fixture=_generated

IsCfnCluster(object)

Checks whether the given object is a CfnCluster.

public static bool IsCfnCluster(object x)
Parameters
x object
Returns

bool

Remarks

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

CloudformationResource: AWS::CloudHSM::Cluster

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

Creates and manages an AWS CloudHSM cluster.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
props IDictionary<string, object>
Returns

IDictionary<string, object>

Overrides
Remarks

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

CloudformationResource: AWS::CloudHSM::Cluster

ExampleMetadata: fixture=_generated

Implements

Constructs.IConstruct
Constructs.IDependable