Skip to content

AWS.Redshift.Cluster

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html

Index

Fields

fn new

new(errorOnEmptyProp)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html

fn creationPolicy

creationPolicy(policy)

Associate the CreationPolicy attribute with a resource to prevent its status from reaching create complete until AWS CloudFormation receives a specified number of success signals or the timeout period is exceeded. To signal a resource, you can use the cfn-signal helper script or SignalResource API. CloudFormation publishes valid signals to the stack events so that you track the number of signals sent. https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-creationpolicy.html

fn creationPolicyMixin

creationPolicyMixin(policy)

cf creationPolicy(), but return a merged object

fn deletionPolicy

deletionPolicy(policy)

With the DeletionPolicy attribute you can preserve, and in some cases, backup a resource when its stack is deleted. You specify a DeletionPolicy attribute for each resource that you want to control. If a resource has no DeletionPolicy attribute, AWS CloudFormation deletes the resource by default. https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html

fn deletionPolicyMixin

deletionPolicyMixin(policy)

cf deletionPolicy(), but return a merged object

fn dependsOn

dependsOn(dependencies)

With the DependsOn attribute you can specify that the creation of a specific resource follows another. When you add a DependsOn attribute to a resource, that resource is created only after the creation of the resource specified in the DependsOn attribute. https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html

fn dependsOnMixin

dependsOnMixin(dependencies)

cf dependsOn(), but return a merged array

fn metadata

metadata(metadatas)

The metadata attribute enables you to associate structured data with a resource. By adding a metadata attribute to a resource, you can add data in JSON or YAML to the resource declaration. In addition, you can use intrinsic functions (such as GetAtt and Ref), parameters, and pseudo parameters within the metadata attribute to add those interpreted values. https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-metadata.html

fn metadataMixin

metadataMixin(metadatas)

cf metadata(), but return a merged object

fn updatePolicy

updatePolicy(policy)

Use the UpdatePolicy attribute to specify how AWS CloudFormation handles updates to the AWS::AppStream::Fleet, AWS::AutoScaling::AutoScalingGroup, AWS::ElastiCache::ReplicationGroup, AWS::OpenSearchService::Domain, AWS::Elasticsearch::Domain, or AWS::Lambda::Alias resources. https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatepolicy.html

fn updatePolicyMixin

updatePolicyMixin(policy)

cf `updatePolicy(), but return a merged object

fn updateReplacePolicy

updateReplacePolicy(policy)

Use the UpdateReplacePolicy attribute to retain or, in some cases, backup the existing physical instance of a resource when it's replaced during a stack update operation. https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html

fn updateReplacePolicyMixin

updateReplacePolicyMixin(policy)

cf updateReplacePolicy, but return a merged object

fn withAllowVersionUpgrade

withAllowVersionUpgrade(allowVersionUpgrade)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-allowversionupgrade

fn withAquaConfigurationStatus

withAquaConfigurationStatus(aquaConfigurationStatus)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-aquaconfigurationstatus

fn withAutomatedSnapshotRetentionPeriod

withAutomatedSnapshotRetentionPeriod(automatedSnapshotRetentionPeriod)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-automatedsnapshotretentionperiod

fn withAvailabilityZone

withAvailabilityZone(availabilityZone)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-availabilityzone

fn withAvailabilityZoneRelocation

withAvailabilityZoneRelocation(availabilityZoneRelocation)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-availabilityzonerelocation

fn withAvailabilityZoneRelocationStatus

withAvailabilityZoneRelocationStatus(availabilityZoneRelocationStatus)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-availabilityzonerelocationstatus

fn withClassic

withClassic(classic)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-classic

fn withClusterIdentifier

withClusterIdentifier(clusterIdentifier)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-clusteridentifier

fn withClusterParameterGroupName

withClusterParameterGroupName(clusterParameterGroupName)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-clusterparametergroupname

fn withClusterSecurityGroups

withClusterSecurityGroups(clusterSecurityGroups)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-clustersecuritygroups

fn withClusterSecurityGroupsMixin

withClusterSecurityGroupsMixin(clusterSecurityGroups)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-clustersecuritygroups

fn withClusterSubnetGroupName

withClusterSubnetGroupName(clusterSubnetGroupName)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-clustersubnetgroupname

fn withClusterType

withClusterType(clusterType)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-clustertype

fn withClusterVersion

withClusterVersion(clusterVersion)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-clusterversion

fn withDBName

withDBName(dbname)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-dbname

fn withDeferMaintenance

withDeferMaintenance(deferMaintenance)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-defermaintenance

fn withDeferMaintenanceDuration

withDeferMaintenanceDuration(deferMaintenanceDuration)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-defermaintenanceduration

fn withDeferMaintenanceEndTime

withDeferMaintenanceEndTime(deferMaintenanceEndTime)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-defermaintenanceendtime

fn withDeferMaintenanceStartTime

withDeferMaintenanceStartTime(deferMaintenanceStartTime)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-defermaintenancestarttime

fn withDestinationRegion

withDestinationRegion(destinationRegion)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-destinationregion

fn withElasticIp

withElasticIp(elasticIp)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-elasticip

fn withEncrypted

withEncrypted(encrypted)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-encrypted

fn withEnhancedVpcRouting

withEnhancedVpcRouting(enhancedVpcRouting)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-enhancedvpcrouting

fn withHsmClientCertificateIdentifier

withHsmClientCertificateIdentifier(hsmClientCertificateIdentifier)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-hsmclientcertificateidentifier

fn withHsmConfigurationIdentifier

withHsmConfigurationIdentifier(hsmConfigurationIdentifier)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-hsmconfigurationidentifier

fn withIamRoles

withIamRoles(iamRoles)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-iamroles

fn withIamRolesMixin

withIamRolesMixin(iamRoles)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-iamroles

fn withKmsKeyId

withKmsKeyId(kmsKeyId)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-kmskeyid

fn withLoggingProperties

withLoggingProperties(loggingProperties)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-loggingproperties

fn withLoggingPropertiesMixin

withLoggingPropertiesMixin(loggingProperties)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-loggingproperties

fn withMaintenanceTrackName

withMaintenanceTrackName(maintenanceTrackName)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-maintenancetrackname

fn withManualSnapshotRetentionPeriod

withManualSnapshotRetentionPeriod(manualSnapshotRetentionPeriod)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-manualsnapshotretentionperiod

fn withMasterUserPassword

withMasterUserPassword(masterUserPassword)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-masteruserpassword

fn withMasterUsername

withMasterUsername(masterUsername)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-masterusername

fn withNodeType

withNodeType(nodeType)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-nodetype

fn withNumberOfNodes

withNumberOfNodes(numberOfNodes)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-numberofnodes

fn withOwnerAccount

withOwnerAccount(ownerAccount)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-owneraccount

fn withPort

withPort(port)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-port

fn withPreferredMaintenanceWindow

withPreferredMaintenanceWindow(preferredMaintenanceWindow)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-preferredmaintenancewindow

fn withPubliclyAccessible

withPubliclyAccessible(publiclyAccessible)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-publiclyaccessible

fn withResourceAction

withResourceAction(resourceAction)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-resourceaction

fn withRevisionTarget

withRevisionTarget(revisionTarget)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-revisiontarget

fn withRotateEncryptionKey

withRotateEncryptionKey(rotateEncryptionKey)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-rotateencryptionkey

fn withSnapshotClusterIdentifier

withSnapshotClusterIdentifier(snapshotClusterIdentifier)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-snapshotclusteridentifier

fn withSnapshotCopyGrantName

withSnapshotCopyGrantName(snapshotCopyGrantName)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-snapshotcopygrantname

fn withSnapshotCopyManual

withSnapshotCopyManual(snapshotCopyManual)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-snapshotcopymanual

fn withSnapshotCopyRetentionPeriod

withSnapshotCopyRetentionPeriod(snapshotCopyRetentionPeriod)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-snapshotcopyretentionperiod

fn withSnapshotIdentifier

withSnapshotIdentifier(snapshotIdentifier)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-snapshotidentifier

fn withTags

withTags(tags)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-tags

fn withTagsMixin

withTagsMixin(tags)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-tags

fn withVpcSecurityGroupIds

withVpcSecurityGroupIds(vpcSecurityGroupIds)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-vpcsecuritygroupids

fn withVpcSecurityGroupIdsMixin

withVpcSecurityGroupIdsMixin(vpcSecurityGroupIds)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-vpcsecuritygroupids