CfnCluster L1 construct
Specifies a cluster. A cluster is a fully managed data warehouse that consists of a set of compute nodes.
To create a cluster in Virtual Private Cloud (VPC), you must provide a cluster subnet group name. The cluster subnet group identifies the subnets of your VPC that Amazon Redshift uses when creating the cluster. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide .
| CloudFormation | AWS::Redshift::Cluster |
|---|---|
| Source | |
| Type last changed |
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_redshift as redshift } from 'aws-cdk-lib';
declare const namespaceResourcePolicy: any;
const cfnCluster = new redshift.CfnCluster(this, 'MyCfnCluster', {
clusterType: 'clusterType',
dbName: 'dbName',
masterUsername: 'masterUsername',
nodeType: 'nodeType',
// the properties below are optional
allowVersionUpgrade: false,
aquaConfigurationStatus: 'aquaConfigurationStatus',
automatedSnapshotRetentionPeriod: 123,
availabilityZone: 'availabilityZone',
availabilityZoneRelocation: false,
availabilityZoneRelocationStatus: 'availabilityZoneRelocationStatus',
classic: false,
clusterIdentifier: 'clusterIdentifier',
clusterParameterGroupName: 'clusterParameterGroupName',
clusterSecurityGroups: ['clusterSecurityGroups'],
clusterSubnetGroupName: 'clusterSubnetGroupName',
clusterVersion: 'clusterVersion',
deferMaintenance: false,
deferMaintenanceDuration: 123,
deferMaintenanceEndTime: 'deferMaintenanceEndTime',
deferMaintenanceStartTime: 'deferMaintenanceStartTime',
destinationRegion: 'destinationRegion',
elasticIp: 'elasticIp',
encrypted: false,
endpoint: {
address: 'address',
port: 'port',
},
enhancedVpcRouting: false,
hsmClientCertificateIdentifier: 'hsmClientCertificateIdentifier',
hsmConfigurationIdentifier: 'hsmConfigurationIdentifier',
iamRoles: ['iamRoles'],
kmsKeyId: 'kmsKeyId',
loggingProperties: {
bucketName: 'bucketName',
logDestinationType: 'logDestinationType',
logExports: ['logExports'],
s3KeyPrefix: 's3KeyPrefix',
},
maintenanceTrackName: 'maintenanceTrackName',
manageMasterPassword: false,
manualSnapshotRetentionPeriod: 123,
masterPasswordSecretKmsKeyId: 'masterPasswordSecretKmsKeyId',
masterUserPassword: 'masterUserPassword',
multiAz: false,
namespaceResourcePolicy: namespaceResourcePolicy,
numberOfNodes: 123,
ownerAccount: 'ownerAccount',
port: 123,
preferredMaintenanceWindow: 'preferredMaintenanceWindow',
publiclyAccessible: false,
resourceAction: 'resourceAction',
revisionTarget: 'revisionTarget',
rotateEncryptionKey: false,
snapshotClusterIdentifier: 'snapshotClusterIdentifier',
snapshotCopyGrantName: 'snapshotCopyGrantName',
snapshotCopyManual: false,
snapshotCopyRetentionPeriod: 123,
snapshotIdentifier: 'snapshotIdentifier',
tags: [{
key: 'key',
value: 'value',
}],
vpcSecurityGroupIds: ['vpcSecurityGroupIds'],
});
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_redshift as redshift
# namespace_resource_policy: Any
cfn_cluster = redshift.CfnCluster(self, "MyCfnCluster",
cluster_type="clusterType",
db_name="dbName",
master_username="masterUsername",
node_type="nodeType",
# the properties below are optional
allow_version_upgrade=False,
aqua_configuration_status="aquaConfigurationStatus",
automated_snapshot_retention_period=123,
availability_zone="availabilityZone",
availability_zone_relocation=False,
availability_zone_relocation_status="availabilityZoneRelocationStatus",
classic=False,
cluster_identifier="clusterIdentifier",
cluster_parameter_group_name="clusterParameterGroupName",
cluster_security_groups=["clusterSecurityGroups"],
cluster_subnet_group_name="clusterSubnetGroupName",
cluster_version="clusterVersion",
defer_maintenance=False,
defer_maintenance_duration=123,
defer_maintenance_end_time="deferMaintenanceEndTime",
defer_maintenance_start_time="deferMaintenanceStartTime",
destination_region="destinationRegion",
elastic_ip="elasticIp",
encrypted=False,
endpoint=redshift.CfnCluster.EndpointProperty(
address="address",
port="port"
),
enhanced_vpc_routing=False,
hsm_client_certificate_identifier="hsmClientCertificateIdentifier",
hsm_configuration_identifier="hsmConfigurationIdentifier",
iam_roles=["iamRoles"],
kms_key_id="kmsKeyId",
logging_properties=redshift.CfnCluster.LoggingPropertiesProperty(
bucket_name="bucketName",
log_destination_type="logDestinationType",
log_exports=["logExports"],
s3_key_prefix="s3KeyPrefix"
),
maintenance_track_name="maintenanceTrackName",
manage_master_password=False,
manual_snapshot_retention_period=123,
master_password_secret_kms_key_id="masterPasswordSecretKmsKeyId",
master_user_password="masterUserPassword",
multi_az=False,
namespace_resource_policy=namespace_resource_policy,
number_of_nodes=123,
owner_account="ownerAccount",
port=123,
preferred_maintenance_window="preferredMaintenanceWindow",
publicly_accessible=False,
resource_action="resourceAction",
revision_target="revisionTarget",
rotate_encryption_key=False,
snapshot_cluster_identifier="snapshotClusterIdentifier",
snapshot_copy_grant_name="snapshotCopyGrantName",
snapshot_copy_manual=False,
snapshot_copy_retention_period=123,
snapshot_identifier="snapshotIdentifier",
tags=[CfnTag(
key="key",
value="value"
)],
vpc_security_group_ids=["vpcSecurityGroupIds"]
)
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.redshift.*;
Object namespaceResourcePolicy;
CfnCluster cfnCluster = CfnCluster.Builder.create(this, "MyCfnCluster")
.clusterType("clusterType")
.dbName("dbName")
.masterUsername("masterUsername")
.nodeType("nodeType")
// the properties below are optional
.allowVersionUpgrade(false)
.aquaConfigurationStatus("aquaConfigurationStatus")
.automatedSnapshotRetentionPeriod(123)
.availabilityZone("availabilityZone")
.availabilityZoneRelocation(false)
.availabilityZoneRelocationStatus("availabilityZoneRelocationStatus")
.classic(false)
.clusterIdentifier("clusterIdentifier")
.clusterParameterGroupName("clusterParameterGroupName")
.clusterSecurityGroups(List.of("clusterSecurityGroups"))
.clusterSubnetGroupName("clusterSubnetGroupName")
.clusterVersion("clusterVersion")
.deferMaintenance(false)
.deferMaintenanceDuration(123)
.deferMaintenanceEndTime("deferMaintenanceEndTime")
.deferMaintenanceStartTime("deferMaintenanceStartTime")
.destinationRegion("destinationRegion")
.elasticIp("elasticIp")
.encrypted(false)
.endpoint(EndpointProperty.builder()
.address("address")
.port("port")
.build())
.enhancedVpcRouting(false)
.hsmClientCertificateIdentifier("hsmClientCertificateIdentifier")
.hsmConfigurationIdentifier("hsmConfigurationIdentifier")
.iamRoles(List.of("iamRoles"))
.kmsKeyId("kmsKeyId")
.loggingProperties(LoggingPropertiesProperty.builder()
.bucketName("bucketName")
.logDestinationType("logDestinationType")
.logExports(List.of("logExports"))
.s3KeyPrefix("s3KeyPrefix")
.build())
.maintenanceTrackName("maintenanceTrackName")
.manageMasterPassword(false)
.manualSnapshotRetentionPeriod(123)
.masterPasswordSecretKmsKeyId("masterPasswordSecretKmsKeyId")
.masterUserPassword("masterUserPassword")
.multiAz(false)
.namespaceResourcePolicy(namespaceResourcePolicy)
.numberOfNodes(123)
.ownerAccount("ownerAccount")
.port(123)
.preferredMaintenanceWindow("preferredMaintenanceWindow")
.publiclyAccessible(false)
.resourceAction("resourceAction")
.revisionTarget("revisionTarget")
.rotateEncryptionKey(false)
.snapshotClusterIdentifier("snapshotClusterIdentifier")
.snapshotCopyGrantName("snapshotCopyGrantName")
.snapshotCopyManual(false)
.snapshotCopyRetentionPeriod(123)
.snapshotIdentifier("snapshotIdentifier")
.tags(List.of(CfnTag.builder()
.key("key")
.value("value")
.build()))
.vpcSecurityGroupIds(List.of("vpcSecurityGroupIds"))
.build();
// 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.Redshift;
var namespaceResourcePolicy;
var cfnCluster = new CfnCluster(this, "MyCfnCluster", new CfnClusterProps {
ClusterType = "clusterType",
DbName = "dbName",
MasterUsername = "masterUsername",
NodeType = "nodeType",
// the properties below are optional
AllowVersionUpgrade = false,
AquaConfigurationStatus = "aquaConfigurationStatus",
AutomatedSnapshotRetentionPeriod = 123,
AvailabilityZone = "availabilityZone",
AvailabilityZoneRelocation = false,
AvailabilityZoneRelocationStatus = "availabilityZoneRelocationStatus",
Classic = false,
ClusterIdentifier = "clusterIdentifier",
ClusterParameterGroupName = "clusterParameterGroupName",
ClusterSecurityGroups = new [] { "clusterSecurityGroups" },
ClusterSubnetGroupName = "clusterSubnetGroupName",
ClusterVersion = "clusterVersion",
DeferMaintenance = false,
DeferMaintenanceDuration = 123,
DeferMaintenanceEndTime = "deferMaintenanceEndTime",
DeferMaintenanceStartTime = "deferMaintenanceStartTime",
DestinationRegion = "destinationRegion",
ElasticIp = "elasticIp",
Encrypted = false,
Endpoint = new EndpointProperty {
Address = "address",
Port = "port"
},
EnhancedVpcRouting = false,
HsmClientCertificateIdentifier = "hsmClientCertificateIdentifier",
HsmConfigurationIdentifier = "hsmConfigurationIdentifier",
IamRoles = new [] { "iamRoles" },
KmsKeyId = "kmsKeyId",
LoggingProperties = new LoggingPropertiesProperty {
BucketName = "bucketName",
LogDestinationType = "logDestinationType",
LogExports = new [] { "logExports" },
S3KeyPrefix = "s3KeyPrefix"
},
MaintenanceTrackName = "maintenanceTrackName",
ManageMasterPassword = false,
ManualSnapshotRetentionPeriod = 123,
MasterPasswordSecretKmsKeyId = "masterPasswordSecretKmsKeyId",
MasterUserPassword = "masterUserPassword",
MultiAz = false,
NamespaceResourcePolicy = namespaceResourcePolicy,
NumberOfNodes = 123,
OwnerAccount = "ownerAccount",
Port = 123,
PreferredMaintenanceWindow = "preferredMaintenanceWindow",
PubliclyAccessible = false,
ResourceAction = "resourceAction",
RevisionTarget = "revisionTarget",
RotateEncryptionKey = false,
SnapshotClusterIdentifier = "snapshotClusterIdentifier",
SnapshotCopyGrantName = "snapshotCopyGrantName",
SnapshotCopyManual = false,
SnapshotCopyRetentionPeriod = 123,
SnapshotIdentifier = "snapshotIdentifier",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
VpcSecurityGroupIds = new [] { "vpcSecurityGroupIds" }
});
// 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"
var namespaceResourcePolicy interface{}
cfnCluster := awscdk.Aws_redshift.NewCfnCluster(this, jsii.String("MyCfnCluster"), &CfnClusterProps{
ClusterType: jsii.String("clusterType"),
DbName: jsii.String("dbName"),
MasterUsername: jsii.String("masterUsername"),
NodeType: jsii.String("nodeType"),
// the properties below are optional
AllowVersionUpgrade: jsii.Boolean(false),
AquaConfigurationStatus: jsii.String("aquaConfigurationStatus"),
AutomatedSnapshotRetentionPeriod: jsii.Number(123),
AvailabilityZone: jsii.String("availabilityZone"),
AvailabilityZoneRelocation: jsii.Boolean(false),
AvailabilityZoneRelocationStatus: jsii.String("availabilityZoneRelocationStatus"),
Classic: jsii.Boolean(false),
ClusterIdentifier: jsii.String("clusterIdentifier"),
ClusterParameterGroupName: jsii.String("clusterParameterGroupName"),
ClusterSecurityGroups: []interface{}{
jsii.String("clusterSecurityGroups"),
},
ClusterSubnetGroupName: jsii.String("clusterSubnetGroupName"),
ClusterVersion: jsii.String("clusterVersion"),
DeferMaintenance: jsii.Boolean(false),
DeferMaintenanceDuration: jsii.Number(123),
DeferMaintenanceEndTime: jsii.String("deferMaintenanceEndTime"),
DeferMaintenanceStartTime: jsii.String("deferMaintenanceStartTime"),
DestinationRegion: jsii.String("destinationRegion"),
ElasticIp: jsii.String("elasticIp"),
Encrypted: jsii.Boolean(false),
Endpoint: &EndpointProperty{
Address: jsii.String("address"),
Port: jsii.String("port"),
},
EnhancedVpcRouting: jsii.Boolean(false),
HsmClientCertificateIdentifier: jsii.String("hsmClientCertificateIdentifier"),
HsmConfigurationIdentifier: jsii.String("hsmConfigurationIdentifier"),
IamRoles: []interface{}{
jsii.String("iamRoles"),
},
KmsKeyId: jsii.String("kmsKeyId"),
LoggingProperties: &LoggingPropertiesProperty{
BucketName: jsii.String("bucketName"),
LogDestinationType: jsii.String("logDestinationType"),
LogExports: []*string{
jsii.String("logExports"),
},
S3KeyPrefix: jsii.String("s3KeyPrefix"),
},
MaintenanceTrackName: jsii.String("maintenanceTrackName"),
ManageMasterPassword: jsii.Boolean(false),
ManualSnapshotRetentionPeriod: jsii.Number(123),
MasterPasswordSecretKmsKeyId: jsii.String("masterPasswordSecretKmsKeyId"),
MasterUserPassword: jsii.String("masterUserPassword"),
MultiAz: jsii.Boolean(false),
NamespaceResourcePolicy: namespaceResourcePolicy,
NumberOfNodes: jsii.Number(123),
OwnerAccount: jsii.String("ownerAccount"),
Port: jsii.Number(123),
PreferredMaintenanceWindow: jsii.String("preferredMaintenanceWindow"),
PubliclyAccessible: jsii.Boolean(false),
ResourceAction: jsii.String("resourceAction"),
RevisionTarget: jsii.String("revisionTarget"),
RotateEncryptionKey: jsii.Boolean(false),
SnapshotClusterIdentifier: jsii.String("snapshotClusterIdentifier"),
SnapshotCopyGrantName: jsii.String("snapshotCopyGrantName"),
SnapshotCopyManual: jsii.Boolean(false),
SnapshotCopyRetentionPeriod: jsii.Number(123),
SnapshotIdentifier: jsii.String("snapshotIdentifier"),
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
VpcSecurityGroupIds: []interface{}{
jsii.String("vpcSecurityGroupIds"),
},
})
Initializer
new CfnCluster(scope: Construct, id: string, props: CfnClusterProps)
CfnCluster(scope: Construct, id: str, props: CfnClusterProps)
new CfnCluster(Construct scope, String id, CfnClusterProps props)
new CfnCluster(Construct scope, string id, CfnClusterProps props)
NewCfnCluster(Scope Construct, Id *string, Props CfnClusterProps)
Construct Props
allowVersionUpgradeoptionalboolean | IResolvableallow_version_upgradeoptionaltyping.Union[bool, IResolvable]allowVersionUpgradeoptionalBooleanAllowVersionUpgradeoptionalboolAllowVersionUpgradeoptionalinterface{} #When a new major version of the Amazon Redshift engine is released, you can request that the service automatically apply upgrades during the maintenance window to the Amazon Redshift engine that is running on your cluster.
Default: true
aquaConfigurationStatusoptionalstringaqua_configuration_statusoptionalstraquaConfigurationStatusoptionalStringAquaConfigurationStatusoptionalstringAquaConfigurationStatusoptional*string #It does not set the AQUA configuration status. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
automatedSnapshotRetentionPeriodoptionalnumberautomated_snapshot_retention_periodoptionalint | floatautomatedSnapshotRetentionPeriodoptionalNumberAutomatedSnapshotRetentionPeriodoptionaldoubleAutomatedSnapshotRetentionPeriodoptional*float64 #notes
If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with CreateClusterSnapshot in the Amazon Redshift API Reference .
Default: 1
Constraints: Must be a value from 0 to 35.
availabilityZoneoptionalstringavailability_zoneoptionalstravailabilityZoneoptionalStringAvailabilityZoneoptionalstringAvailabilityZoneoptional*string #notes
For example, if you have several EC2 instances running in a specific Availability Zone, then you might want the cluster to be provisioned in the same zone in order to decrease network latency.
Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint.
Example: us-east-2d
Constraint: The specified Availability Zone must be in the same region as the current endpoint.
availabilityZoneRelocationoptionalboolean | IResolvableavailability_zone_relocationoptionaltyping.Union[bool, IResolvable]availabilityZoneRelocationoptionalBooleanAvailabilityZoneRelocationoptionalboolAvailabilityZoneRelocationoptionalinterface{} #availabilityZoneRelocationStatusoptionalstringavailability_zone_relocation_statusoptionalstravailabilityZoneRelocationStatusoptionalStringAvailabilityZoneRelocationStatusoptionalstringAvailabilityZoneRelocationStatusoptional*string #classicoptionalboolean | IResolvableclassicoptionaltyping.Union[bool, IResolvable]classicoptionalBooleanClassicoptionalboolClassicoptionalinterface{} #If you don't provide this parameter or set the value to false , the resize type is elastic.
clusterIdentifieroptionalstringcluster_identifieroptionalstrclusterIdentifieroptionalStringClusterIdentifieroptionalstringClusterIdentifieroptional*string #notes
You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. The identifier also appears in the Amazon Redshift console.
Constraints:
- Must contain from 1 to 63 alphanumeric characters or hyphens.
- Alphabetic characters must be lowercase.
- First character must be a letter.
- Cannot end with a hyphen or contain two consecutive hyphens.
- Must be unique for all clusters within an AWS account .
Example: myexamplecluster
clusterParameterGroupNameoptionalstring | IClusterParameterGroupRefcluster_parameter_group_nameoptionaltyping.Union[str, IClusterParameterGroupRef]clusterParameterGroupNameoptionalStringClusterParameterGroupNameoptionalstringClusterParameterGroupNameoptionalinterface{} #notes
Default: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to Working with Amazon Redshift Parameter Groups
Constraints:
- Must be 1 to 255 alphanumeric characters or hyphens.
- First character must be a letter.
- Cannot end with a hyphen or contain two consecutive hyphens.
clusterSecurityGroupsoptionalstring | ISecurityGroupRef | IClusterSecurityGroupRef[]cluster_security_groupsoptionaltyping.List[typing.Union[str, ISecurityGroupRef, IClusterSecurityGroupRef]]clusterSecurityGroupsoptionalList<String>ClusterSecurityGroupsoptionalstring[]ClusterSecurityGroupsoptional*[]interface{} #Default: The default cluster security group for Amazon Redshift.
clusterSubnetGroupNameoptionalstring | IClusterSubnetGroupRefcluster_subnet_group_nameoptionaltyping.Union[str, IClusterSubnetGroupRef]clusterSubnetGroupNameoptionalStringClusterSubnetGroupNameoptionalstringClusterSubnetGroupNameoptionalinterface{} #If this parameter is not provided the resulting cluster will be deployed outside virtual private cloud (VPC).
single-node, the NumberOfNodes parameter is not required.multi-node, the NumberOfNodes parameter is required.
Valid Values: multi-node | single-node
Default: multi-node
clusterVersionoptionalstringcluster_versionoptionalstrclusterVersionoptionalStringClusterVersionoptionalstringClusterVersionoptional*string #The version selected runs on all the nodes in the cluster.
Constraints: Only version 1.0 is currently available.
Example: 1.0
notes
To create additional databases after the cluster is created, connect to the cluster with a SQL client and use SQL commands to create a database. For more information, go to Create a Database in the Amazon Redshift Database Developer Guide.
Default: dev
Constraints:
- Must contain 1 to 64 alphanumeric characters.
- Must contain only lowercase letters.
- Cannot be a word that is reserved by the service. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.
deferMaintenanceoptionalboolean | IResolvabledefer_maintenanceoptionaltyping.Union[bool, IResolvable]deferMaintenanceoptionalBooleanDeferMaintenanceoptionalboolDeferMaintenanceoptionalinterface{} #deferMaintenanceDurationoptionalnumberdefer_maintenance_durationoptionalint | floatdeferMaintenanceDurationoptionalNumberDeferMaintenanceDurationoptionaldoubleDeferMaintenanceDurationoptional*float64 #If you specify a duration, you can't specify an end time. The duration must be 45 days or less.
deferMaintenanceEndTimeoptionalstringdefer_maintenance_end_timeoptionalstrdeferMaintenanceEndTimeoptionalStringDeferMaintenanceEndTimeoptionalstringDeferMaintenanceEndTimeoptional*string #deferMaintenanceStartTimeoptionalstringdefer_maintenance_start_timeoptionalstrdeferMaintenanceStartTimeoptionalStringDeferMaintenanceStartTimeoptionalstringDeferMaintenanceStartTimeoptional*string #destinationRegionoptionalstringdestination_regionoptionalstrdestinationRegionoptionalStringDestinationRegionoptionalstringDestinationRegionoptional*string #elasticIpoptionalstring | IEIPRefelastic_ipoptionaltyping.Union[str, IEIPRef]elasticIpoptionalStringElasticIpoptionalstringElasticIpoptionalinterface{} #notes
Constraints: The cluster must be provisioned in EC2-VPC and publicly-accessible through an Internet gateway. Don't specify the Elastic IP address for a publicly accessible cluster with availability zone relocation turned on. For more information about provisioning clusters in EC2-VPC, go to Supported Platforms to Launch Your Cluster in the Amazon Redshift Cluster Management Guide.
encryptedoptionalboolean | IResolvableencryptedoptionaltyping.Union[bool, IResolvable]encryptedoptionalBooleanEncryptedoptionalboolEncryptedoptionalinterface{} #If you set the value on this parameter to false , the request will fail.
Default: true
endpointoptionalIResolvable | CfnCluster.EndpointPropertyendpointoptionaltyping.Union[IResolvable, EndpointProperty]endpointoptionalIResolvableEndpointoptionalIResolvableEndpointoptionalinterface{} #enhancedVpcRoutingoptionalboolean | IResolvableenhanced_vpc_routingoptionaltyping.Union[bool, IResolvable]enhancedVpcRoutingoptionalBooleanEnhancedVpcRoutingoptionalboolEnhancedVpcRoutingoptionalinterface{} #notes
To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.
If this option is true , enhanced VPC routing is enabled.
Default: false
hsmClientCertificateIdentifieroptionalstringhsm_client_certificate_identifieroptionalstrhsmClientCertificateIdentifieroptionalStringHsmClientCertificateIdentifieroptionalstringHsmClientCertificateIdentifieroptional*string #hsmConfigurationIdentifieroptionalstringhsm_configuration_identifieroptionalstrhsmConfigurationIdentifieroptionalStringHsmConfigurationIdentifieroptionalstringHsmConfigurationIdentifieroptional*string #iamRolesoptionalstring | IRoleRef[]iam_rolesoptionaltyping.List[typing.Union[str, IRoleRef]]iamRolesoptionalList<String>IamRolesoptionalstring[]IamRolesoptional*[]interface{} #notes
You must supply the IAM roles in their Amazon Resource Name (ARN) format.
The maximum number of IAM roles that you can associate is subject to a quota. For more information, go to Quotas and limits in the Amazon Redshift Cluster Management Guide .
kmsKeyIdoptionalstring | IKeyRefkms_key_idoptionaltyping.Union[str, IKeyRef]kmsKeyIdoptionalStringKmsKeyIdoptionalstringKmsKeyIdoptionalinterface{} #loggingPropertiesoptionalIResolvable | CfnCluster.logging_propertiesoptionaltyping.Union[IResolvable, LoggingPropertiesProperty]loggingPropertiesoptionalIResolvableLoggingPropertiesoptionalIResolvableLoggingPropertiesoptionalinterface{} #maintenanceTrackNameoptionalstringmaintenance_track_nameoptionalstrmaintenanceTrackNameoptionalStringMaintenanceTrackNameoptionalstringMaintenanceTrackNameoptional*string #If you don't provide a maintenance track name, the cluster is assigned to the current track.
manageMasterPasswordoptionalboolean | IResolvablemanage_master_passwordoptionaltyping.Union[bool, IResolvable]manageMasterPasswordoptionalBooleanManageMasterPasswordoptionalboolManageMasterPasswordoptionalinterface{} #You can't use MasterUserPassword if ManageMasterPassword is true. If ManageMasterPassword is false or not set, Amazon Redshift uses MasterUserPassword for the admin user account's password.
manualSnapshotRetentionPeriodoptionalnumbermanual_snapshot_retention_periodoptionalint | floatmanualSnapshotRetentionPeriodoptionalNumberManualSnapshotRetentionPeriodoptionaldoubleManualSnapshotRetentionPeriodoptional*float64 #If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots.
The value must be either -1 or an integer between 1 and 3,653.
masterPasswordSecretKmsKeyIdoptionalstring | IKeyRefmaster_password_secret_kms_key_idoptionaltyping.Union[str, IKeyRef]masterPasswordSecretKmsKeyIdoptionalStringMasterPasswordSecretKmsKeyIdoptionalstringMasterPasswordSecretKmsKeyIdoptionalinterface{} #You can only use this parameter if ManageMasterPassword is true.
masterUsernamestringmaster_usernamestrmasterUsernameStringMasterUsernamestringMasterUsername*string required #notes
Constraints:
- Must be 1 - 128 alphanumeric characters or hyphens. The user name can't be
PUBLIC. - Must contain only lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen.
- The first character must be a letter.
- Must not contain a colon (😃 or a slash (/).
- Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.
masterUserPasswordoptionalstringmaster_user_passwordoptionalstrmasterUserPasswordoptionalStringMasterUserPasswordoptionalstringMasterUserPasswordoptional*string #notes
You can't use MasterUserPassword if ManageMasterPassword is true .
Constraints:
- Must be between 8 and 64 characters in length.
- Must contain at least one uppercase letter.
- Must contain at least one lowercase letter.
- Must contain one number.
- Can be any printable ASCII character (ASCII code 33-126) except
'(single quote),"(double quote),\,/, or@.
multiAzoptionalboolean | IResolvablemulti_azoptionaltyping.Union[bool, IResolvable]multiAzoptionalBooleanMultiAzoptionalboolMultiAzoptionalinterface{} #The default is false.
namespaceResourcePolicyoptionalanynamespace_resource_policyoptionalAnynamespaceResourcePolicyoptionalObjectNamespaceResourcePolicyoptionalobjectNamespaceResourcePolicyoptionalinterface{} #notes
For information about node types, go to Working with Clusters in the Amazon Redshift Cluster Management Guide .
Valid Values: dc2.large | dc2.8xlarge | ra3.large | ra3.xlplus | ra3.4xlarge | ra3.16xlarge
numberOfNodesoptionalnumbernumber_of_nodesoptionalint | floatnumberOfNodesoptionalNumberNumberOfNodesoptionaldoubleNumberOfNodesoptional*float64 #notes
This parameter is required when the ClusterType parameter is specified as multi-node .
For information about determining how many nodes you need, go to Working with Clusters in the Amazon Redshift Cluster Management Guide .
If you don't specify this parameter, you get a single-node cluster. When requesting a multi-node cluster, you must specify the number of nodes that you want in the cluster.
Default: 1
Constraints: Value must be at least 1 and no more than 100.
ownerAccountoptionalstringowner_accountoptionalstrownerAccountoptionalStringOwnerAccountoptionalstringOwnerAccountoptional*string #Required if you are restoring a snapshot you do not own, optional if you own the snapshot.
notes
The cluster is accessible only via the JDBC and ODBC connection strings. Part of the connection string requires the port on which the cluster will listen for incoming connections.
Default: 5439
Valid Values:
- For clusters with ra3 nodes - Select a port within the ranges
5431-5455or8191-8215. (If you have an existing cluster with ra3 nodes, it isn't required that you change the port to these ranges.) - For clusters with dc2 nodes - Select a port within the range
1150-65535.
preferredMaintenanceWindowoptionalstringpreferred_maintenance_windowoptionalstrpreferredMaintenanceWindowoptionalStringPreferredMaintenanceWindowoptionalstringPreferredMaintenanceWindowoptional*string #notes
Format: ddd:hh24:mi-ddd:hh24:mi
Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. For more information about the time blocks for each region, see Maintenance Windows in Amazon Redshift Cluster Management Guide.
Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun
Constraints: Minimum 30-minute window.
publiclyAccessibleoptionalboolean | IResolvablepublicly_accessibleoptionaltyping.Union[bool, IResolvable]publiclyAccessibleoptionalBooleanPubliclyAccessibleoptionalboolPubliclyAccessibleoptionalinterface{} #Default: false
resourceActionoptionalstringresource_actionoptionalstrresourceActionoptionalStringResourceActionoptionalstringResourceActionoptional*string #Supported operations are pause-cluster , resume-cluster , and failover-primary-compute .
revisionTargetoptionalstringrevision_targetoptionalstrrevisionTargetoptionalStringRevisionTargetoptionalstringRevisionTargetoptional*string #rotateEncryptionKeyoptionalboolean | IResolvablerotate_encryption_keyoptionaltyping.Union[bool, IResolvable]rotateEncryptionKeyoptionalBooleanRotateEncryptionKeyoptionalboolRotateEncryptionKeyoptionalinterface{} #snapshotClusterIdentifieroptionalstringsnapshot_cluster_identifieroptionalstrsnapshotClusterIdentifieroptionalStringSnapshotClusterIdentifieroptionalstringSnapshotClusterIdentifieroptional*string #This parameter is required if your user or role has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.
snapshotCopyGrantNameoptionalstringsnapshot_copy_grant_nameoptionalstrsnapshotCopyGrantNameoptionalStringSnapshotCopyGrantNameoptionalstringSnapshotCopyGrantNameoptional*string #snapshotCopyManualoptionalboolean | IResolvablesnapshot_copy_manualoptionaltyping.Union[bool, IResolvable]snapshotCopyManualoptionalBooleanSnapshotCopyManualoptionalboolSnapshotCopyManualoptionalinterface{} #snapshotCopyRetentionPeriodoptionalnumbersnapshot_copy_retention_periodoptionalint | floatsnapshotCopyRetentionPeriodoptionalNumberSnapshotCopyRetentionPeriodoptionaldoubleSnapshotCopyRetentionPeriodoptional*float64 #notes
By default, this only changes the retention period of copied automated snapshots.
If you decrease the retention period for automated snapshots that are copied to a destination AWS Region , Amazon Redshift deletes any existing automated snapshots that were copied to the destination AWS Region and that fall outside of the new retention period.
Constraints: Must be at least 1 and no more than 35 for automated snapshots.
If you specify the manual option, only newly copied manual snapshots will have the new retention period.
If you specify the value of -1 newly copied manual snapshots are retained indefinitely.
Constraints: The number of days must be either -1 or an integer between 1 and 3,653 for manual snapshots.
snapshotIdentifieroptionalstringsnapshot_identifieroptionalstrsnapshotIdentifieroptionalStringSnapshotIdentifieroptionalstringSnapshotIdentifieroptional*string #This parameter isn't case sensitive. You must specify this parameter or snapshotArn , but not both.
Example: my-snapshot-id
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag #vpcSecurityGroupIdsoptionalstring | ISecurityGroupRef[]vpc_security_group_idsoptionaltyping.List[typing.Union[str, ISecurityGroupRef]]vpcSecurityGroupIdsoptionalList<String>VpcSecurityGroupIdsoptionalstring[]VpcSecurityGroupIdsoptional*[]interface{} #Default: The default VPC security group is associated with the cluster.
Properties
allowVersionUpgrademay be undefinedboolean | IResolvableallow_version_upgrademay be undefinedtyping.Union[bool, IResolvable]allowVersionUpgrademay be undefinedBooleanAllowVersionUpgrademay be undefinedboolAllowVersionUpgrademay be undefinedinterface{} #aquaConfigurationStatusmay be undefinedstringaqua_configuration_statusmay be undefinedstraquaConfigurationStatusmay be undefinedStringAquaConfigurationStatusmay be undefinedstringAquaConfigurationStatusmay be undefined*string #attrClusterNamespaceArnstringattr_cluster_namespace_arnstrattrClusterNamespaceArnStringAttrClusterNamespaceArnstringAttrClusterNamespaceArn*string #attrDeferMaintenanceIdentifierstringattr_defer_maintenance_identifierstrattrDeferMaintenanceIdentifierStringAttrDeferMaintenanceIdentifierstringAttrDeferMaintenanceIdentifier*string #attrEndpointAddressstringattr_endpoint_addressstrattrEndpointAddressStringAttrEndpointAddressstringAttrEndpointAddress*string #For example: examplecluster.cg034hpkmmjt.us-east-1.redshift.amazonaws.com .
attrEndpointPortstringattr_endpoint_portstrattrEndpointPortStringAttrEndpointPortstringAttrEndpointPort*string #For example: 5439 .
attrMasterPasswordSecretArnstringattr_master_password_secret_arnstrattrMasterPasswordSecretArnStringAttrMasterPasswordSecretArnstringAttrMasterPasswordSecretArn*string #automatedSnapshotRetentionPeriodmay be undefinednumberautomated_snapshot_retention_periodmay be undefinedint | floatautomatedSnapshotRetentionPeriodmay be undefinedNumberAutomatedSnapshotRetentionPeriodmay be undefineddoubleAutomatedSnapshotRetentionPeriodmay be undefined*float64 #availabilityZonemay be undefinedstringavailability_zonemay be undefinedstravailabilityZonemay be undefinedStringAvailabilityZonemay be undefinedstringAvailabilityZonemay be undefined*string #availabilityZoneRelocationmay be undefinedboolean | IResolvableavailability_zone_relocationmay be undefinedtyping.Union[bool, IResolvable]availabilityZoneRelocationmay be undefinedBooleanAvailabilityZoneRelocationmay be undefinedboolAvailabilityZoneRelocationmay be undefinedinterface{} #availabilityZoneRelocationStatusmay be undefinedstringavailability_zone_relocation_statusmay be undefinedstravailabilityZoneRelocationStatusmay be undefinedStringAvailabilityZoneRelocationStatusmay be undefinedstringAvailabilityZoneRelocationStatusmay be undefined*string #CFN_RESOURCE_TYPE_NAMEstringCFN_RESOURCE_TYPE_NAMEstrCFN_RESOURCE_TYPE_NAMEStringCFN_RESOURCE_TYPE_NAMEstringCFN_RESOURCE_TYPE_NAME*string static #cfnOptionsICfnResourceOptionscfn_optionsICfnResourceOptionscfnOptionsICfnResourceOptionsCfnOptionsICfnResourceOptionsCfnOptionsICfnResourceOptions #cfnResourceTypestringcfn_resource_typestrcfnResourceTypeStringCfnResourceTypestringCfnResourceType*string #classicmay be undefinedboolean | IResolvableclassicmay be undefinedtyping.Union[bool, IResolvable]classicmay be undefinedBooleanClassicmay be undefinedboolClassicmay be undefinedinterface{} #clusterIdentifiermay be undefinedstringcluster_identifiermay be undefinedstrclusterIdentifiermay be undefinedStringClusterIdentifiermay be undefinedstringClusterIdentifiermay be undefined*string #clusterParameterGroupNamemay be undefinedstringcluster_parameter_group_namemay be undefinedstrclusterParameterGroupNamemay be undefinedStringClusterParameterGroupNamemay be undefinedstringClusterParameterGroupNamemay be undefined*string #clusterRefClusterReferencecluster_refClusterReferenceclusterRefClusterReferenceClusterRefClusterReferenceClusterRefClusterReference #clusterSecurityGroupsmay be undefinedstring[]cluster_security_groupsmay be undefinedtyping.List[str]clusterSecurityGroupsmay be undefinedList<String>ClusterSecurityGroupsmay be undefinedstring[]ClusterSecurityGroupsmay be undefined*[]*string #clusterSubnetGroupNamemay be undefinedstringcluster_subnet_group_namemay be undefinedstrclusterSubnetGroupNamemay be undefinedStringClusterSubnetGroupNamemay be undefinedstringClusterSubnetGroupNamemay be undefined*string #When cluster type is specified as.
clusterVersionmay be undefinedstringcluster_versionmay be undefinedstrclusterVersionmay be undefinedStringClusterVersionmay be undefinedstringClusterVersionmay be undefined*string #creationStackstring[]creation_stacktyping.List[str]creationStackList<String>CreationStackstring[]CreationStack*[]*string #deferMaintenancemay be undefinedboolean | IResolvabledefer_maintenancemay be undefinedtyping.Union[bool, IResolvable]deferMaintenancemay be undefinedBooleanDeferMaintenancemay be undefinedboolDeferMaintenancemay be undefinedinterface{} #deferMaintenanceDurationmay be undefinednumberdefer_maintenance_durationmay be undefinedint | floatdeferMaintenanceDurationmay be undefinedNumberDeferMaintenanceDurationmay be undefineddoubleDeferMaintenanceDurationmay be undefined*float64 #deferMaintenanceEndTimemay be undefinedstringdefer_maintenance_end_timemay be undefinedstrdeferMaintenanceEndTimemay be undefinedStringDeferMaintenanceEndTimemay be undefinedstringDeferMaintenanceEndTimemay be undefined*string #deferMaintenanceStartTimemay be undefinedstringdefer_maintenance_start_timemay be undefinedstrdeferMaintenanceStartTimemay be undefinedStringDeferMaintenanceStartTimemay be undefinedstringDeferMaintenanceStartTimemay be undefined*string #destinationRegionmay be undefinedstringdestination_regionmay be undefinedstrdestinationRegionmay be undefinedStringDestinationRegionmay be undefinedstringDestinationRegionmay be undefined*string #elasticIpmay be undefinedstringelastic_ipmay be undefinedstrelasticIpmay be undefinedStringElasticIpmay be undefinedstringElasticIpmay be undefined*string #encryptedmay be undefinedboolean | IResolvableencryptedmay be undefinedtyping.Union[bool, IResolvable]encryptedmay be undefinedBooleanEncryptedmay be undefinedboolEncryptedmay be undefinedinterface{} #endpointmay be undefinedIResolvable | CfnCluster.EndpointPropertyendpointmay be undefinedtyping.Union[IResolvable, EndpointProperty]endpointmay be undefinedIResolvableEndpointmay be undefinedIResolvableEndpointmay be undefinedinterface{} #enhancedVpcRoutingmay be undefinedboolean | IResolvableenhanced_vpc_routingmay be undefinedtyping.Union[bool, IResolvable]enhancedVpcRoutingmay be undefinedBooleanEnhancedVpcRoutingmay be undefinedboolEnhancedVpcRoutingmay be undefinedinterface{} #hsmClientCertificateIdentifiermay be undefinedstringhsm_client_certificate_identifiermay be undefinedstrhsmClientCertificateIdentifiermay be undefinedStringHsmClientCertificateIdentifiermay be undefinedstringHsmClientCertificateIdentifiermay be undefined*string #hsmConfigurationIdentifiermay be undefinedstringhsm_configuration_identifiermay be undefinedstrhsmConfigurationIdentifiermay be undefinedStringHsmConfigurationIdentifiermay be undefinedstringHsmConfigurationIdentifiermay be undefined*string #iamRolesmay be undefinedstring[]iam_rolesmay be undefinedtyping.List[str]iamRolesmay be undefinedList<String>IamRolesmay be undefinedstring[]IamRolesmay be undefined*[]*string #kmsKeyIdmay be undefinedstringkms_key_idmay be undefinedstrkmsKeyIdmay be undefinedStringKmsKeyIdmay be undefinedstringKmsKeyIdmay be undefined*string #loggingPropertiesmay be undefinedIResolvable | CfnCluster.logging_propertiesmay be undefinedtyping.Union[IResolvable, LoggingPropertiesProperty]loggingPropertiesmay be undefinedIResolvableLoggingPropertiesmay be undefinedIResolvableLoggingPropertiesmay be undefinedinterface{} #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).
maintenanceTrackNamemay be undefinedstringmaintenance_track_namemay be undefinedstrmaintenanceTrackNamemay be undefinedStringMaintenanceTrackNamemay be undefinedstringMaintenanceTrackNamemay be undefined*string #manageMasterPasswordmay be undefinedboolean | IResolvablemanage_master_passwordmay be undefinedtyping.Union[bool, IResolvable]manageMasterPasswordmay be undefinedBooleanManageMasterPasswordmay be undefinedboolManageMasterPasswordmay be undefinedinterface{} #manualSnapshotRetentionPeriodmay be undefinednumbermanual_snapshot_retention_periodmay be undefinedint | floatmanualSnapshotRetentionPeriodmay be undefinedNumberManualSnapshotRetentionPeriodmay be undefineddoubleManualSnapshotRetentionPeriodmay be undefined*float64 #masterPasswordSecretKmsKeyIdmay be undefinedstringmaster_password_secret_kms_key_idmay be undefinedstrmasterPasswordSecretKmsKeyIdmay be undefinedStringMasterPasswordSecretKmsKeyIdmay be undefinedstringMasterPasswordSecretKmsKeyIdmay be undefined*string #masterUsernamestringmaster_usernamestrmasterUsernameStringMasterUsernamestringMasterUsername*string #masterUserPasswordmay be undefinedstringmaster_user_passwordmay be undefinedstrmasterUserPasswordmay be undefinedStringMasterUserPasswordmay be undefinedstringMasterUserPasswordmay be undefined*string #multiAzmay be undefinedboolean | IResolvablemulti_azmay be undefinedtyping.Union[bool, IResolvable]multiAzmay be undefinedBooleanMultiAzmay be undefinedboolMultiAzmay be undefinedinterface{} #namespaceResourcePolicyanynamespace_resource_policyAnynamespaceResourcePolicyObjectNamespaceResourcePolicyobjectNamespaceResourcePolicyinterface{} #numberOfNodesmay be undefinednumbernumber_of_nodesmay be undefinedint | floatnumberOfNodesmay be undefinedNumberNumberOfNodesmay be undefineddoubleNumberOfNodesmay be undefined*float64 #ownerAccountmay be undefinedstringowner_accountmay be undefinedstrownerAccountmay be undefinedStringOwnerAccountmay be undefinedstringOwnerAccountmay be undefined*string #portmay be undefinednumberportmay be undefinedint | floatportmay be undefinedNumberPortmay be undefineddoublePortmay be undefined*float64 #preferredMaintenanceWindowmay be undefinedstringpreferred_maintenance_windowmay be undefinedstrpreferredMaintenanceWindowmay be undefinedStringPreferredMaintenanceWindowmay be undefinedstringPreferredMaintenanceWindowmay be undefined*string #publiclyAccessiblemay be undefinedboolean | IResolvablepublicly_accessiblemay be undefinedtyping.Union[bool, IResolvable]publiclyAccessiblemay be undefinedBooleanPubliclyAccessiblemay be undefinedboolPubliclyAccessiblemay be undefinedinterface{} #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 }).
resourceActionmay be undefinedstringresource_actionmay be undefinedstrresourceActionmay be undefinedStringResourceActionmay be undefinedstringResourceActionmay be undefined*string #revisionTargetmay be undefinedstringrevision_targetmay be undefinedstrrevisionTargetmay be undefinedStringRevisionTargetmay be undefinedstringRevisionTargetmay be undefined*string #rotateEncryptionKeymay be undefinedboolean | IResolvablerotate_encryption_keymay be undefinedtyping.Union[bool, IResolvable]rotateEncryptionKeymay be undefinedBooleanRotateEncryptionKeymay be undefinedboolRotateEncryptionKeymay be undefinedinterface{} #snapshotClusterIdentifiermay be undefinedstringsnapshot_cluster_identifiermay be undefinedstrsnapshotClusterIdentifiermay be undefinedStringSnapshotClusterIdentifiermay be undefinedstringSnapshotClusterIdentifiermay be undefined*string #snapshotCopyGrantNamemay be undefinedstringsnapshot_copy_grant_namemay be undefinedstrsnapshotCopyGrantNamemay be undefinedStringSnapshotCopyGrantNamemay be undefinedstringSnapshotCopyGrantNamemay be undefined*string #snapshotCopyManualmay be undefinedboolean | IResolvablesnapshot_copy_manualmay be undefinedtyping.Union[bool, IResolvable]snapshotCopyManualmay be undefinedBooleanSnapshotCopyManualmay be undefinedboolSnapshotCopyManualmay be undefinedinterface{} #snapshotCopyRetentionPeriodmay be undefinednumbersnapshot_copy_retention_periodmay be undefinedint | floatsnapshotCopyRetentionPeriodmay be undefinedNumberSnapshotCopyRetentionPeriodmay be undefineddoubleSnapshotCopyRetentionPeriodmay be undefined*float64 #snapshotIdentifiermay be undefinedstringsnapshot_identifiermay be undefinedstrsnapshotIdentifiermay be undefinedStringSnapshotIdentifiermay be undefinedstringSnapshotIdentifiermay be undefined*string #CfnElements must be defined within a stack scope (directly or indirectly).
tagsRawmay be undefinedCfnTag[]tags_rawmay be undefinedtyping.List[CfnTag]tagsRawmay be undefinedList<CfnTag>TagsRawmay be undefinedCfnTag[]TagsRawmay be undefined*[]CfnTag #vpcSecurityGroupIdsmay be undefinedstring[]vpc_security_group_idsmay be undefinedtyping.List[str]vpcSecurityGroupIdsmay be undefinedList<String>VpcSecurityGroupIdsmay be undefinedstring[]VpcSecurityGroupIdsmay be undefined*[]*string #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) #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 #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 #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{}) #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{}) #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,
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
would add the overrides
"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) #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{}) #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) #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) #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) #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:
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 #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 #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{} #inspect(inspector: TreeInspector): voiddef inspect(self, inspector: TreeInspector) -> Nonepublic void inspect(TreeInspector inspector)public void Inspect(TreeInspector inspector)func Inspect(Inspector TreeInspector) #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{}) *bool static #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{}) *bool static #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{}) *bool static #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{}) *bool static #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{} #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) #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 #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) #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) #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
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 #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.