CfnCluster L1 construct
Specifies a cluster .
All nodes in the cluster run the same protocol-compliant engine software.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_memorydb as memorydb } from 'aws-cdk-lib';
const cfnCluster = new memorydb.CfnCluster(this, 'MyCfnCluster', {
aclName: 'aclName',
clusterName: 'clusterName',
nodeType: 'nodeType',
// the properties below are optional
autoMinorVersionUpgrade: false,
clusterEndpoint: {
address: 'address',
port: 123,
},
dataTiering: 'dataTiering',
description: 'description',
engine: 'engine',
engineVersion: 'engineVersion',
finalSnapshotName: 'finalSnapshotName',
ipDiscovery: 'ipDiscovery',
kmsKeyId: 'kmsKeyId',
maintenanceWindow: 'maintenanceWindow',
multiRegionClusterName: 'multiRegionClusterName',
networkType: 'networkType',
numReplicasPerShard: 123,
numShards: 123,
parameterGroupName: 'parameterGroupName',
port: 123,
securityGroupIds: ['securityGroupIds'],
snapshotArns: ['snapshotArns'],
snapshotName: 'snapshotName',
snapshotRetentionLimit: 123,
snapshotWindow: 'snapshotWindow',
snsTopicArn: 'snsTopicArn',
snsTopicStatus: 'snsTopicStatus',
subnetGroupName: 'subnetGroupName',
tags: [{
key: 'key',
value: 'value',
}],
tlsEnabled: false,
});
python
from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_memorydb as memorydb
cfn_cluster = memorydb.CfnCluster(self, "MyCfnCluster",
acl_name="aclName",
cluster_name="clusterName",
node_type="nodeType",
# the properties below are optional
auto_minor_version_upgrade=False,
cluster_endpoint=memorydb.CfnCluster.EndpointProperty(
address="address",
port=123
),
data_tiering="dataTiering",
description="description",
engine="engine",
engine_version="engineVersion",
final_snapshot_name="finalSnapshotName",
ip_discovery="ipDiscovery",
kms_key_id="kmsKeyId",
maintenance_window="maintenanceWindow",
multi_region_cluster_name="multiRegionClusterName",
network_type="networkType",
num_replicas_per_shard=123,
num_shards=123,
parameter_group_name="parameterGroupName",
port=123,
security_group_ids=["securityGroupIds"],
snapshot_arns=["snapshotArns"],
snapshot_name="snapshotName",
snapshot_retention_limit=123,
snapshot_window="snapshotWindow",
sns_topic_arn="snsTopicArn",
sns_topic_status="snsTopicStatus",
subnet_group_name="subnetGroupName",
tags=[CfnTag(
key="key",
value="value"
)],
tls_enabled=False
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.memorydb.*;
CfnCluster cfnCluster = CfnCluster.Builder.create(this, "MyCfnCluster")
.aclName("aclName")
.clusterName("clusterName")
.nodeType("nodeType")
// the properties below are optional
.autoMinorVersionUpgrade(false)
.clusterEndpoint(EndpointProperty.builder()
.address("address")
.port(123)
.build())
.dataTiering("dataTiering")
.description("description")
.engine("engine")
.engineVersion("engineVersion")
.finalSnapshotName("finalSnapshotName")
.ipDiscovery("ipDiscovery")
.kmsKeyId("kmsKeyId")
.maintenanceWindow("maintenanceWindow")
.multiRegionClusterName("multiRegionClusterName")
.networkType("networkType")
.numReplicasPerShard(123)
.numShards(123)
.parameterGroupName("parameterGroupName")
.port(123)
.securityGroupIds(List.of("securityGroupIds"))
.snapshotArns(List.of("snapshotArns"))
.snapshotName("snapshotName")
.snapshotRetentionLimit(123)
.snapshotWindow("snapshotWindow")
.snsTopicArn("snsTopicArn")
.snsTopicStatus("snsTopicStatus")
.subnetGroupName("subnetGroupName")
.tags(List.of(CfnTag.builder()
.key("key")
.value("value")
.build()))
.tlsEnabled(false)
.build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.MemoryDB;
var cfnCluster = new CfnCluster(this, "MyCfnCluster", new CfnClusterProps {
AclName = "aclName",
ClusterName = "clusterName",
NodeType = "nodeType",
// the properties below are optional
AutoMinorVersionUpgrade = false,
ClusterEndpoint = new EndpointProperty {
Address = "address",
Port = 123
},
DataTiering = "dataTiering",
Description = "description",
Engine = "engine",
EngineVersion = "engineVersion",
FinalSnapshotName = "finalSnapshotName",
IpDiscovery = "ipDiscovery",
KmsKeyId = "kmsKeyId",
MaintenanceWindow = "maintenanceWindow",
MultiRegionClusterName = "multiRegionClusterName",
NetworkType = "networkType",
NumReplicasPerShard = 123,
NumShards = 123,
ParameterGroupName = "parameterGroupName",
Port = 123,
SecurityGroupIds = new [] { "securityGroupIds" },
SnapshotArns = new [] { "snapshotArns" },
SnapshotName = "snapshotName",
SnapshotRetentionLimit = 123,
SnapshotWindow = "snapshotWindow",
SnsTopicArn = "snsTopicArn",
SnsTopicStatus = "snsTopicStatus",
SubnetGroupName = "subnetGroupName",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
TlsEnabled = false
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnCluster := awscdk.Aws_memorydb.NewCfnCluster(this, jsii.String("MyCfnCluster"), &CfnClusterProps{
AclName: jsii.String("aclName"),
ClusterName: jsii.String("clusterName"),
NodeType: jsii.String("nodeType"),
// the properties below are optional
AutoMinorVersionUpgrade: jsii.Boolean(false),
ClusterEndpoint: &EndpointProperty{
Address: jsii.String("address"),
Port: jsii.Number(123),
},
DataTiering: jsii.String("dataTiering"),
Description: jsii.String("description"),
Engine: jsii.String("engine"),
EngineVersion: jsii.String("engineVersion"),
FinalSnapshotName: jsii.String("finalSnapshotName"),
IpDiscovery: jsii.String("ipDiscovery"),
KmsKeyId: jsii.String("kmsKeyId"),
MaintenanceWindow: jsii.String("maintenanceWindow"),
MultiRegionClusterName: jsii.String("multiRegionClusterName"),
NetworkType: jsii.String("networkType"),
NumReplicasPerShard: jsii.Number(123),
NumShards: jsii.Number(123),
ParameterGroupName: jsii.String("parameterGroupName"),
Port: jsii.Number(123),
SecurityGroupIds: []interface{}{
jsii.String("securityGroupIds"),
},
SnapshotArns: []*string{
jsii.String("snapshotArns"),
},
SnapshotName: jsii.String("snapshotName"),
SnapshotRetentionLimit: jsii.Number(123),
SnapshotWindow: jsii.String("snapshotWindow"),
SnsTopicArn: jsii.String("snsTopicArn"),
SnsTopicStatus: jsii.String("snsTopicStatus"),
SubnetGroupName: jsii.String("subnetGroupName"),
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
TlsEnabled: jsii.Boolean(false),
})
Initializer
ts
new CfnCluster(scope: Construct, id: string, props: CfnClusterProps)
python
CfnCluster(scope: Construct, id: str, props: CfnClusterProps)
java
new CfnCluster(Construct scope, String id, CfnClusterProps props)
csharp
new CfnCluster(Construct scope, string id, CfnClusterProps props)
go
NewCfnCluster(Scope Construct, Id *string, Props CfnClusterProps)
Construct Props
The name of the Access Control List to associate with the cluster .
autoMinorVersionUpgradeoptionalboolean | IResolvableauto_minor_version_upgradeoptionaltyping.Union[bool, IResolvable]autoMinorVersionUpgradeoptionalBooleanAutoMinorVersionUpgradeoptionalboolAutoMinorVersionUpgradeoptionalinterface{}#When set to true, the cluster will automatically receive minor engine version upgrades after launch.
clusterEndpointoptionalIResolvable | CfnCluster.EndpointPropertycluster_endpointoptionaltyping.Union[IResolvable, EndpointProperty]clusterEndpointoptionalIResolvableClusterEndpointoptionalIResolvableClusterEndpointoptionalinterface{}#The cluster 's configuration endpoint.
The name of the cluster .
dataTieringoptionalstringdata_tieringoptionalstrdataTieringoptionalStringDataTieringoptionalstringDataTieringoptional*string#Enables data tiering.
Data tiering is only supported for clusters using the r6gd node type. This parameter must be set when using r6gd nodes. For more information, see Data tiering .
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#A description of the cluster .
The name of the engine used by the cluster.
engineVersionoptionalstringengine_versionoptionalstrengineVersionoptionalStringEngineVersionoptionalstringEngineVersionoptional*string#The Redis engine version used by the cluster .
finalSnapshotNameoptionalstringfinal_snapshot_nameoptionalstrfinalSnapshotNameoptionalStringFinalSnapshotNameoptionalstringFinalSnapshotNameoptional*string#The user-supplied name of a final cluster snapshot.
This is the unique name that identifies the snapshot. MemoryDB creates the snapshot, and then deletes the cluster immediately afterward.
ipDiscoveryoptionalstringip_discoveryoptionalstripDiscoveryoptionalStringIpDiscoveryoptionalstringIpDiscoveryoptional*string#The mechanism that the cluster uses to discover IP addresses.
Returns 'ipv4' when DNS endpoints resolve to IPv4 addresses, or 'ipv6' when DNS endpoints resolve to IPv6 addresses.
kmsKeyIdoptionalstringkms_key_idoptionalstrkmsKeyIdoptionalStringKmsKeyIdoptionalstringKmsKeyIdoptional*string#The ID of the KMS key used to encrypt the cluster .
maintenanceWindowoptionalstringmaintenance_windowoptionalstrmaintenanceWindowoptionalStringMaintenanceWindowoptionalstringMaintenanceWindowoptional*string#Specifies the weekly time range during which maintenance on the cluster is performed.
It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.
Pattern : ddd:hh24:mi-ddd:hh24:mi
multiRegionClusterNameoptionalstringmulti_region_cluster_nameoptionalstrmultiRegionClusterNameoptionalStringMultiRegionClusterNameoptionalstringMultiRegionClusterNameoptional*string#The name of the multi-Region cluster that this cluster belongs to.
networkTypeoptionalstringnetwork_typeoptionalstrnetworkTypeoptionalStringNetworkTypeoptionalstringNetworkTypeoptional*string#The IP address type for the cluster.
Returns 'ipv4' for IPv4 only, 'ipv6' for IPv6 only, or 'dual-stack' if the cluster supports both IPv4 and IPv6 addressing.
The cluster 's node type.
numReplicasPerShardoptionalnumbernum_replicas_per_shardoptionalint | floatnumReplicasPerShardoptionalNumberNumReplicasPerShardoptionaldoubleNumReplicasPerShardoptional*float64#The number of replicas to apply to each shard.
Default value : 1
Maximum value : 5
numShardsoptionalnumbernum_shardsoptionalint | floatnumShardsoptionalNumberNumShardsoptionaldoubleNumShardsoptional*float64#The number of shards in the cluster .
parameterGroupNameoptionalstringparameter_group_nameoptionalstrparameterGroupNameoptionalStringParameterGroupNameoptionalstringParameterGroupNameoptional*string#The name of the parameter group used by the cluster .
The port used by the cluster .
securityGroupIdsoptionalstring | ISecurityGroupRef[]security_group_idsoptionaltyping.List[typing.Union[str, ISecurityGroupRef]]securityGroupIdsoptionalList<String>SecurityGroupIdsoptionalstring[]SecurityGroupIdsoptional*[]interface{}#A list of security group names to associate with this cluster .
snapshotArnsoptionalstring[]snapshot_arnsoptionaltyping.List[str]snapshotArnsoptionalList<String>SnapshotArnsoptionalstring[]SnapshotArnsoptional*[]*string#A list of Amazon Resource Names (ARN) that uniquely identify the RDB snapshot files stored in Amazon S3.
The snapshot files are used to populate the new cluster . The Amazon S3 object name in the ARN cannot contain any commas.
snapshotNameoptionalstringsnapshot_nameoptionalstrsnapshotNameoptionalStringSnapshotNameoptionalstringSnapshotNameoptional*string#The name of a snapshot from which to restore data into the new cluster .
The snapshot status changes to restoring while the new cluster is being created.
snapshotRetentionLimitoptionalnumbersnapshot_retention_limitoptionalint | floatsnapshotRetentionLimitoptionalNumberSnapshotRetentionLimitoptionaldoubleSnapshotRetentionLimitoptional*float64#The number of days for which MemoryDB retains automatic snapshots before deleting them.
For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.
snapshotWindowoptionalstringsnapshot_windowoptionalstrsnapshotWindowoptionalStringSnapshotWindowoptionalstringSnapshotWindowoptional*string#The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard.
Example: 05:00-09:00 If you do not specify this parameter, MemoryDB automatically chooses an appropriate time range.
snsTopicArnoptionalstringsns_topic_arnoptionalstrsnsTopicArnoptionalStringSnsTopicArnoptionalstringSnsTopicArnoptional*string#When you pass the logical ID of this resource to the intrinsic `Ref` function, Ref returns the ARN of the SNS topic, such as `arn:aws:memorydb:us-east-1:123456789012:mySNSTopic`.
snsTopicStatusoptionalstringsns_topic_statusoptionalstrsnsTopicStatusoptionalStringSnsTopicStatusoptionalstringSnsTopicStatusoptional*string#The SNS topic must be in Active status to receive notifications.
subnetGroupNameoptionalstringsubnet_group_nameoptionalstrsubnetGroupNameoptionalStringSubnetGroupNameoptionalstringSubnetGroupNameoptional*string#The name of the subnet group used by the cluster .
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#An array of key-value pairs to apply to this resource.
For more information, see Tag .
tlsEnabledoptionalboolean | IResolvabletls_enabledoptionaltyping.Union[bool, IResolvable]tlsEnabledoptionalBooleanTlsEnabledoptionalboolTlsEnabledoptionalinterface{}#A flag to indicate if In-transit encryption is enabled.
Properties
The name of the Access Control List to associate with the cluster .
When you pass the logical ID of this resource to the intrinsic `Ref` function, Ref returns the ARN of the cluster , such as `arn:aws:memorydb:us-east-1:123456789012:cluster/my-cluster`.
attrClusterEndpointAddressstringattr_cluster_endpoint_addressstrattrClusterEndpointAddressStringAttrClusterEndpointAddressstringAttrClusterEndpointAddress*stringrequired#The address of the cluster 's configuration endpoint.
attrClusterEndpointPortnumberattr_cluster_endpoint_portint | floatattrClusterEndpointPortNumberAttrClusterEndpointPortdoubleAttrClusterEndpointPort*float64required#The port used by the cluster configuration endpoint.
attrParameterGroupStatusstringattr_parameter_group_statusstrattrParameterGroupStatusStringAttrParameterGroupStatusstringAttrParameterGroupStatus*stringrequired#The status of the parameter group used by the cluster , for example `active` or `applying` .
The status of the cluster.
For example, 'available', 'updating' or 'creating'.
autoMinorVersionUpgrademay be undefinedboolean | IResolvableauto_minor_version_upgrademay be undefinedtyping.Union[bool, IResolvable]autoMinorVersionUpgrademay be undefinedBooleanAutoMinorVersionUpgrademay be undefinedboolAutoMinorVersionUpgrademay be undefinedinterface{}#When set to true, the cluster will automatically receive minor engine version upgrades after launch.
CFN_RESOURCE_TYPE_NAMEstringcfn_resource_type_namestrCFN_RESOURCE_TYPE_NAMEStringCFN_RESOURCE_TYPE_NAMEstringCFN_RESOURCE_TYPE_NAME*stringrequiredstatic#The CloudFormation resource type name for this resource class.
cfnOptionsICfnResourceOptionscfn_optionsICfnResourceOptionscfnOptionsICfnResourceOptionsCfnOptionsICfnResourceOptionsCfnOptionsICfnResourceOptionsrequired#Options for this resource, such as condition, update policy etc.
cfnResourceTypestringcfn_resource_typestrcfnResourceTypeStringCfnResourceTypestringCfnResourceType*stringrequired#AWS resource type.
clusterEndpointmay be undefinedIResolvable | CfnCluster.EndpointPropertycluster_endpointmay be undefinedtyping.Union[IResolvable, EndpointProperty]clusterEndpointmay be undefinedIResolvableClusterEndpointmay be undefinedIResolvableClusterEndpointmay be undefinedinterface{}#The cluster 's configuration endpoint.
The name of the cluster .
clusterRefClusterReferencecluster_refClusterReferenceclusterRefClusterReferenceClusterRefClusterReferenceClusterRefClusterReferencerequired#A reference to a Cluster resource.
creationStackstring[]creation_stacktyping.List[str]creationStackList<String>CreationStackstring[]CreationStack*[]*stringrequired#dataTieringmay be undefinedstringdata_tieringmay be undefinedstrdataTieringmay be undefinedStringDataTieringmay be undefinedstringDataTieringmay be undefined*string#Enables data tiering.
descriptionmay be undefinedstringdescriptionmay be undefinedstrdescriptionmay be undefinedStringDescriptionmay be undefinedstringDescriptionmay be undefined*string#A description of the cluster .
enginemay be undefinedstringenginemay be undefinedstrenginemay be undefinedStringEnginemay be undefinedstringEnginemay be undefined*string#The name of the engine used by the cluster.
engineVersionmay be undefinedstringengine_versionmay be undefinedstrengineVersionmay be undefinedStringEngineVersionmay be undefinedstringEngineVersionmay be undefined*string#The Redis engine version used by the cluster .
finalSnapshotNamemay be undefinedstringfinal_snapshot_namemay be undefinedstrfinalSnapshotNamemay be undefinedStringFinalSnapshotNamemay be undefinedstringFinalSnapshotNamemay be undefined*string#The user-supplied name of a final cluster snapshot.
ipDiscoverymay be undefinedstringip_discoverymay be undefinedstripDiscoverymay be undefinedStringIpDiscoverymay be undefinedstringIpDiscoverymay be undefined*string#The mechanism that the cluster uses to discover IP addresses.
kmsKeyIdmay be undefinedstringkms_key_idmay be undefinedstrkmsKeyIdmay be undefinedStringKmsKeyIdmay be undefinedstringKmsKeyIdmay be undefined*string#The ID of the KMS key used to encrypt the cluster .
The logical ID for this CloudFormation stack element.
The logical ID of the element is calculated from the path of the resource node in the construct tree.
To override this value, use overrideLogicalId(newLogicalId).
maintenanceWindowmay be undefinedstringmaintenance_windowmay be undefinedstrmaintenanceWindowmay be undefinedStringMaintenanceWindowmay be undefinedstringMaintenanceWindowmay be undefined*string#Specifies the weekly time range during which maintenance on the cluster is performed.
multiRegionClusterNamemay be undefinedstringmulti_region_cluster_namemay be undefinedstrmultiRegionClusterNamemay be undefinedStringMultiRegionClusterNamemay be undefinedstringMultiRegionClusterNamemay be undefined*string#The name of the multi-Region cluster that this cluster belongs to.
networkTypemay be undefinedstringnetwork_typemay be undefinedstrnetworkTypemay be undefinedStringNetworkTypemay be undefinedstringNetworkTypemay be undefined*string#The IP address type for the cluster.
The cluster 's node type.
numReplicasPerShardmay be undefinednumbernum_replicas_per_shardmay be undefinedint | floatnumReplicasPerShardmay be undefinedNumberNumReplicasPerShardmay be undefineddoubleNumReplicasPerShardmay be undefined*float64#The number of replicas to apply to each shard.
numShardsmay be undefinednumbernum_shardsmay be undefinedint | floatnumShardsmay be undefinedNumberNumShardsmay be undefineddoubleNumShardsmay be undefined*float64#The number of shards in the cluster .
parameterGroupNamemay be undefinedstringparameter_group_namemay be undefinedstrparameterGroupNamemay be undefinedStringParameterGroupNamemay be undefinedstringParameterGroupNamemay be undefined*string#The name of the parameter group used by the cluster .
portmay be undefinednumberportmay be undefinedint | floatportmay be undefinedNumberPortmay be undefineddoublePortmay be undefined*float64#The port used by the cluster .
Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).
securityGroupIdsmay be undefinedstring[]security_group_idsmay be undefinedtyping.List[str]securityGroupIdsmay be undefinedList<String>SecurityGroupIdsmay be undefinedstring[]SecurityGroupIdsmay be undefined*[]*string#A list of security group names to associate with this cluster .
snapshotArnsmay be undefinedstring[]snapshot_arnsmay be undefinedtyping.List[str]snapshotArnsmay be undefinedList<String>SnapshotArnsmay be undefinedstring[]SnapshotArnsmay be undefined*[]*string#A list of Amazon Resource Names (ARN) that uniquely identify the RDB snapshot files stored in Amazon S3.
snapshotNamemay be undefinedstringsnapshot_namemay be undefinedstrsnapshotNamemay be undefinedStringSnapshotNamemay be undefinedstringSnapshotNamemay be undefined*string#The name of a snapshot from which to restore data into the new cluster .
snapshotRetentionLimitmay be undefinednumbersnapshot_retention_limitmay be undefinedint | floatsnapshotRetentionLimitmay be undefinedNumberSnapshotRetentionLimitmay be undefineddoubleSnapshotRetentionLimitmay be undefined*float64#The number of days for which MemoryDB retains automatic snapshots before deleting them.
snapshotWindowmay be undefinedstringsnapshot_windowmay be undefinedstrsnapshotWindowmay be undefinedStringSnapshotWindowmay be undefinedstringSnapshotWindowmay be undefined*string#The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard.
snsTopicArnmay be undefinedstringsns_topic_arnmay be undefinedstrsnsTopicArnmay be undefinedStringSnsTopicArnmay be undefinedstringSnsTopicArnmay be undefined*string#When you pass the logical ID of this resource to the intrinsic `Ref` function, Ref returns the ARN of the SNS topic, such as `arn:aws:memorydb:us-east-1:123456789012:mySNSTopic`.
snsTopicStatusmay be undefinedstringsns_topic_statusmay be undefinedstrsnsTopicStatusmay be undefinedStringSnsTopicStatusmay be undefinedstringSnsTopicStatusmay be undefined*string#The SNS topic must be in Active status to receive notifications.
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
subnetGroupNamemay be undefinedstringsubnet_group_namemay be undefinedstrsubnetGroupNamemay be undefinedStringSubnetGroupNamemay be undefinedstringSubnetGroupNamemay be undefined*string#The name of the subnet group used by the cluster .
Tag Manager which manages the tags for this resource.
tagsRawmay be undefinedCfnTag[]tags_rawmay be undefinedtyping.List[CfnTag]tagsRawmay be undefinedList<CfnTag>TagsRawmay be undefinedCfnTag[]TagsRawmay be undefined*[]CfnTag#An array of key-value pairs to apply to this resource.
tlsEnabledmay be undefinedboolean | IResolvabletls_enabledmay be undefinedtyping.Union[bool, IResolvable]tlsEnabledmay be undefinedBooleanTlsEnabledmay be undefinedboolTlsEnabledmay be undefinedinterface{}#A flag to indicate if In-transit encryption is enabled.
Methods
addDeletionOverride(path: string): voiddef add_deletion_override(self, path: str) -> Nonepublic void addDeletionOverride(String path)public void AddDeletionOverride(string path)func AddDeletionOverride(Path *string)#Syntactic sugar for `addOverride(path, undefined)`.
1 parameter
Parameters
pathpathpathpathPath— The path of the value to delete.
addDependency(target: CfnResource): voiddef add_dependency(self, target: CfnResource) -> Nonepublic void addDependency(CfnResource target)public void AddDependency(CfnResource target)func AddDependency(Target CfnResource)deprecated#Use `addResourceDependency` instead.
This method has been renamed to addResourceDependency to more clearly set it apart from construct.node.addDependency. See the documentation of that function for more details.
addDependsOn(target: CfnResource): voiddef add_depends_on(self, target: CfnResource) -> Nonepublic void addDependsOn(CfnResource target)public void AddDependsOn(CfnResource target)func AddDependsOn(Target CfnResource)deprecated#Use `addResourceDependency` instead.
notes
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
This method has been renamed to addResourceDependency, which makes it more clear that this method operates at a different level from the construct-level construct.node.addDependency() mechanism.
addMetadata(key: string, value: any): voiddef add_metadata(self, key: str, value: Any) -> Nonepublic void addMetadata(String key, Object value)public void AddMetadata(string key, object value)func AddMetadata(Key *string, Value interface{})#Add a value to the CloudFormation Resource Metadata.
addOverride(path: string, value: any): voiddef add_override(self, path: str, value: Any) -> Nonepublic void addOverride(String path, Object value)public void AddOverride(string path, object value)func AddOverride(Path *string, Value interface{})#Adds an override to the synthesized CloudFormation resource.
notes · 2 parameters
To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).
If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.
To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.
For example,
typescript
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
would add the overrides
json
"Properties": {
"GlobalSecondaryIndexes": [
{
"Projection": {
"NonKeyAttributes": [ "myattribute" ]
...
}
...
},
{
"ProjectionType": "INCLUDE"
...
},
]
...
}
The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.
Parameters
pathpathpathpathPath— - The path of the property, you can use dot notation to override values in complex types.valuevaluevaluevalueValue— - The value.
addPropertyDeletionOverride(propertyPath: string): voiddef add_property_deletion_override(self, property_path: str) -> Nonepublic void addPropertyDeletionOverride(String propertyPath)public void AddPropertyDeletionOverride(string propertyPath)func AddPropertyDeletionOverride(PropertyPath *string)#Adds an override that deletes the value of a property from the resource definition.
1 parameter
Parameters
propertyPathproperty_pathpropertyPathpropertyPathPropertyPath— The path to the property.
addPropertyOverride(propertyPath: string, value: any): voiddef add_property_override(self, property_path: str, value: Any) -> Nonepublic void addPropertyOverride(String propertyPath, Object value)public void AddPropertyOverride(string propertyPath, object value)func AddPropertyOverride(PropertyPath *string, Value interface{})#Adds an override to a resource property.
Syntactic sugar for addOverride("Properties.<...>", value).
2 parameters
Parameters
propertyPathproperty_pathpropertyPathpropertyPathPropertyPath— The path of the property.valuevaluevaluevalueValue— The value.
addResourceDependency(target: CfnResource, reason?: string): voiddef add_resource_dependency(self, target: CfnResource, reason: typing.Optional[str] = None) -> Nonepublic void addResourceDependency(CfnResource target, String reason)public void AddResourceDependency(CfnResource target, string? reason = null)func AddResourceDependency(Target CfnResource, Reason *string)#Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
notes
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
This method only adds dependencies between L1 resources. If you are looking for a generic construct-to-construct dependency mechanism that works for all constructs including L2s, use construct.node.addDependency instead.
applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#Sets the cross-stack reference strength for this resource.
When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.
1 parameter
Parameters
strengthstrengthstrengthstrengthStrength— - The reference strength to use for this resource.
applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): voiddef apply_removal_policy(self, policy: typing.Optional[RemovalPolicy] = None, options: typing.Optional[RemovalPolicyOptions] = None) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy, RemovalPolicyOptions options)public void ApplyRemovalPolicy(RemovalPolicy? policy = null, RemovalPolicyOptions? options = null)func ApplyRemovalPolicy(Policy RemovalPolicy, Options RemovalPolicyOptions)#Sets the deletion policy of the resource based on the removal policy specified.
notes
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.
The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:
arnForCluster(resource: IClusterRef): string@staticmethod def arn_for_cluster(resource: IClusterRef) -> strpublic static String arnForCluster(IClusterRef resource)public static string ArnForCluster(IClusterRef resource)func ArnForCluster(Resource IClusterRef) *stringstatic#cfnPropertyName(cdkPropertyName: string): stringdef cfn_property_name(self, cdk_property_name: str) -> strpublic String cfnPropertyName(String cdkPropertyName)public string CfnPropertyName(string cdkPropertyName)func CfnPropertyName(CdkPropertyName *string) *string#fromClusterArn(scope: Construct, id: string, arn: string): IClusterRef@staticmethod def from_cluster_arn(scope: Construct, id: str, arn: str) -> IClusterRefpublic static IClusterRef fromClusterArn(Construct scope, String id, String arn)public static IClusterRef FromClusterArn(Construct scope, string id, string arn)func FromClusterArn(Scope Construct, Id *string, Arn *string) IClusterRefstatic#Creates a new IClusterRef from an ARN.
fromClusterName(scope: Construct, id: string, clusterName: string): IClusterRef@staticmethod def from_cluster_name(scope: Construct, id: str, cluster_name: str) -> IClusterRefpublic static IClusterRef fromClusterName(Construct scope, String id, String clusterName)public static IClusterRef FromClusterName(Construct scope, string id, string clusterName)func FromClusterName(Scope Construct, Id *string, ClusterName *string) IClusterRefstatic#Creates a new IClusterRef from a clusterName.
getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Referencedef get_att(self, attribute_name: str, type_hint: typing.Optional[ResolutionTypeHint] = None) -> Referencepublic Reference getAtt(String attributeName, ResolutionTypeHint typeHint)public Reference GetAtt(string attributeName, ResolutionTypeHint? typeHint = null)func GetAtt(AttributeName *string, TypeHint ResolutionTypeHint) Reference#Returns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.
1 parameter
Parameters
attributeNameattribute_nameattributeNameattributeNameAttributeName— The name of the attribute.
getMetadata(key: string): anydef get_metadata(self, key: str) -> Anypublic Object getMetadata(String key)public object GetMetadata(string key)func GetMetadata(Key *string) interface{}#Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector: TreeInspector): voiddef inspect(self, inspector: TreeInspector) -> Nonepublic void inspect(TreeInspector inspector)public void Inspect(TreeInspector inspector)func Inspect(Inspector TreeInspector)#Examines the CloudFormation resource and discloses attributes.
1 parameter
Parameters
inspectorinspectorinspectorinspectorInspector— tree inspector to collect and process attributes.
isCfnCluster(x: any): boolean@staticmethod def is_cfn_cluster(x: Any) -> boolpublic static Boolean isCfnCluster(Object x)public static bool IsCfnCluster(object x)func IsCfnCluster(X interface{}) *boolstatic#Checks whether the given object is a CfnCluster.
isCfnElement(x: any): boolean@staticmethod def is_cfn_element(x: Any) -> boolpublic static Boolean isCfnElement(Object x)public static bool IsCfnElement(object x)func IsCfnElement(X interface{}) *boolstatic#Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.
returns
Returns: The construct as a stack element or undefined if it is not a stack element.
isCfnResource(x: any): boolean@staticmethod def is_cfn_resource(x: Any) -> boolpublic static Boolean isCfnResource(Object x)public static bool IsCfnResource(object x)func IsCfnResource(X interface{}) *boolstatic#Check whether the given object is a CfnResource.
isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#Checks if `x` is a construct.
notes · 1 parameter · returns
Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.
Parameters
xxxxX— Any object.
Returns: true if x is an object created from a class which extends Construct.
obtainDependencies(): Stack | CfnResource[]def obtain_dependencies(self, ) -> typing.List[typing.Union[Stack, CfnResource]]public List<Stack> obtainDependencies()public Stack[] ObtainDependencies()func ObtainDependencies() *[]interface{}#Retrieves an array of resources and stacks this resource depends on.
For resources depended on directly, returns the CfnResource object. For dependencies on other stacks, returns the Stack object. The order of the array is not guaranteed.
overrideLogicalId(newLogicalId: string): voiddef override_logical_id(self, new_logical_id: str) -> Nonepublic void overrideLogicalId(String newLogicalId)public void OverrideLogicalId(string newLogicalId)func OverrideLogicalId(NewLogicalId *string)#Overrides the auto-generated logical ID with a specific ID.
1 parameter
Parameters
newLogicalIdnew_logical_idnewLogicalIdnewLogicalIdNewLogicalId— The new logical ID to use for this stack element.
removeDependency(target: CfnResource): voiddef remove_dependency(self, target: CfnResource) -> Nonepublic void removeDependency(CfnResource target)public void RemoveDependency(CfnResource target)func RemoveDependency(Target CfnResource)deprecated#Use `removeResourceDependency` instead
This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
removeResourceDependency(target: CfnResource): voiddef remove_resource_dependency(self, target: CfnResource) -> Nonepublic void removeResourceDependency(CfnResource target)public void RemoveResourceDependency(CfnResource target)func RemoveResourceDependency(Target CfnResource)#Indicates that this resource no longer depends on another resource.
This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
replaceDependency(target: CfnResource, newTarget: CfnResource): voiddef replace_dependency(self, target: CfnResource, new_target: CfnResource) -> Nonepublic void replaceDependency(CfnResource target, CfnResource newTarget)public void ReplaceDependency(CfnResource target, CfnResource newTarget)func ReplaceDependency(Target CfnResource, NewTarget CfnResource)#Replaces one dependency with another.
2 parameters
Parameters
targettargettargettargetTarget— The dependency to replace.newTargetnew_targetnewTargetnewTargetNewTarget— The new dependency to add.
toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#Returns a string representation of this construct.
returns
Returns: a string representation of this resource
with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.