Class CfnCluster
- All Implemented Interfaces:
IEnvironmentAware,IInspectable,ITaggable,IClusterRef,software.amazon.jsii.JsiiSerializable,software.constructs.IConstruct,software.constructs.IDependable
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 .
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.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();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classA fluent builder forCfnCluster.static interfaceDescribes a connection endpoint.static interfaceSpecifies logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationModeNested classes/interfaces inherited from interface software.amazon.awscdk.services.redshift.IClusterRef
IClusterRef.Jsii$Default, IClusterRef.Jsii$ProxyNested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$DefaultNested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$ProxyNested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable
ITaggable.Jsii$Default, ITaggable.Jsii$Proxy -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringThe CloudFormation resource type name for this resource class. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedCfnCluster(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protectedCfnCluster(software.amazon.jsii.JsiiObjectRef objRef) CfnCluster(software.constructs.Construct scope, String id, CfnClusterProps props) -
Method Summary
Modifier and TypeMethodDescriptionIftrue, major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.This parameter is retired.The namespace Amazon Resource Name (ARN) of the cluster.A unique identifier for the maintenance window.The connection endpoint for the Amazon Redshift cluster.The port number on which the Amazon Redshift cluster accepts connections.The Amazon Resource Name (ARN) for the cluster's admin user credentials secret.The number of days that automated snapshots are retained.The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster.The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is created.Describes the status of the Availability Zone relocation operation.A boolean value indicating whether the resize operation is using the classic resize process.A unique identifier for the cluster.The name of the parameter group to be associated with this cluster.A reference to a Cluster resource.A list of security groups to be associated with this cluster.The name of a cluster subnet group to be associated with this cluster.The type of the cluster.The version of the Amazon Redshift engine software that you want to deploy on the cluster.The name of the first database to be created when the cluster is created.A Boolean indicating whether to enable the deferred maintenance window.An integer indicating the duration of the maintenance window in days.A timestamp for the end of the time period when we defer maintenance.A timestamp indicating the start time for the deferred maintenance window.The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled.The Elastic IP (EIP) address for the cluster.Iftrue, the data in the cluster is encrypted at rest.The connection endpoint.An option that specifies whether to create the cluster with enhanced VPC routing enabled.Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services.The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.Specifies logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.An optional parameter for the name of the maintenance track for the cluster.Iftrue, Amazon Redshift uses AWS Secrets Manager to manage this cluster's admin credentials.The default number of days to retain a manual snapshot.The ID of the AWS Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret.The user name associated with the admin user account for the cluster that is being created.The password associated with the admin user account for the cluster that is being created.A boolean indicating whether Amazon Redshift should deploy the cluster in two Availability Zones.The policy that is attached to a resource.The node type to be provisioned for the cluster.The number of compute nodes in the cluster.The AWS account used to create or copy the snapshot.getPort()The port number on which the cluster accepts incoming connections.The weekly time range (in UTC) during which automated cluster maintenance can occur.Iftrue, the cluster can be accessed from a public network.The Amazon Redshift operation to be performed.Describes aRevisionTargetobject.Rotates the encryption keys for a cluster.The name of the cluster the source snapshot was created from.The name of the snapshot copy grant.Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots.The number of days to retain automated snapshots in the destination AWS Region after they are copied from the source AWS Region .The name of the snapshot from which to create the new cluster.getTags()Tag Manager which manages the tags for this resource.A list of tag instances.A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.voidinspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties(Map<String, Object> props) voidsetAllowVersionUpgrade(Boolean value) Iftrue, major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.voidIftrue, major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.voidsetAquaConfigurationStatus(String value) This parameter is retired.voidThe number of days that automated snapshots are retained.voidsetAvailabilityZone(String value) The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster.voidThe option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is created.voidThe option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is created.voidDescribes the status of the Availability Zone relocation operation.voidsetClassic(Boolean value) A boolean value indicating whether the resize operation is using the classic resize process.voidsetClassic(IResolvable value) A boolean value indicating whether the resize operation is using the classic resize process.voidsetClusterIdentifier(String value) A unique identifier for the cluster.voidThe name of the parameter group to be associated with this cluster.voidsetClusterSecurityGroups(List<String> value) A list of security groups to be associated with this cluster.voidsetClusterSubnetGroupName(String value) The name of a cluster subnet group to be associated with this cluster.voidsetClusterType(String value) The type of the cluster.voidsetClusterVersion(String value) The version of the Amazon Redshift engine software that you want to deploy on the cluster.voidThe name of the first database to be created when the cluster is created.voidsetDeferMaintenance(Boolean value) A Boolean indicating whether to enable the deferred maintenance window.voidsetDeferMaintenance(IResolvable value) A Boolean indicating whether to enable the deferred maintenance window.voidAn integer indicating the duration of the maintenance window in days.voidsetDeferMaintenanceEndTime(String value) A timestamp for the end of the time period when we defer maintenance.voidA timestamp indicating the start time for the deferred maintenance window.voidsetDestinationRegion(String value) The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled.voidsetElasticIp(String value) The Elastic IP (EIP) address for the cluster.voidsetEncrypted(Boolean value) Iftrue, the data in the cluster is encrypted at rest.voidsetEncrypted(IResolvable value) Iftrue, the data in the cluster is encrypted at rest.voidsetEndpoint(IResolvable value) The connection endpoint.voidThe connection endpoint.voidsetEnhancedVpcRouting(Boolean value) An option that specifies whether to create the cluster with enhanced VPC routing enabled.voidsetEnhancedVpcRouting(IResolvable value) An option that specifies whether to create the cluster with enhanced VPC routing enabled.voidSpecifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.voidSpecifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.voidsetIamRoles(List<String> value) A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services.voidsetKmsKeyId(String value) The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.voidsetLoggingProperties(IResolvable value) Specifies logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.voidSpecifies logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.voidsetMaintenanceTrackName(String value) An optional parameter for the name of the maintenance track for the cluster.voidsetManageMasterPassword(Boolean value) Iftrue, Amazon Redshift uses AWS Secrets Manager to manage this cluster's admin credentials.voidIftrue, Amazon Redshift uses AWS Secrets Manager to manage this cluster's admin credentials.voidThe default number of days to retain a manual snapshot.voidThe ID of the AWS Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret.voidsetMasterUsername(String value) The user name associated with the admin user account for the cluster that is being created.voidsetMasterUserPassword(String value) The password associated with the admin user account for the cluster that is being created.voidsetMultiAz(Boolean value) A boolean indicating whether Amazon Redshift should deploy the cluster in two Availability Zones.voidsetMultiAz(IResolvable value) A boolean indicating whether Amazon Redshift should deploy the cluster in two Availability Zones.voidsetNamespaceResourcePolicy(Object value) The policy that is attached to a resource.voidsetNodeType(String value) The node type to be provisioned for the cluster.voidsetNumberOfNodes(Number value) The number of compute nodes in the cluster.voidsetOwnerAccount(String value) The AWS account used to create or copy the snapshot.voidThe port number on which the cluster accepts incoming connections.voidThe weekly time range (in UTC) during which automated cluster maintenance can occur.voidsetPubliclyAccessible(Boolean value) Iftrue, the cluster can be accessed from a public network.voidsetPubliclyAccessible(IResolvable value) Iftrue, the cluster can be accessed from a public network.voidsetResourceAction(String value) The Amazon Redshift operation to be performed.voidsetRevisionTarget(String value) Describes aRevisionTargetobject.voidsetRotateEncryptionKey(Boolean value) Rotates the encryption keys for a cluster.voidRotates the encryption keys for a cluster.voidThe name of the cluster the source snapshot was created from.voidsetSnapshotCopyGrantName(String value) The name of the snapshot copy grant.voidsetSnapshotCopyManual(Boolean value) Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots.voidsetSnapshotCopyManual(IResolvable value) Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots.voidThe number of days to retain automated snapshots in the destination AWS Region after they are copied from the source AWS Region .voidsetSnapshotIdentifier(String value) The name of the snapshot from which to create the new cluster.voidsetTagsRaw(List<CfnTag> value) A list of tag instances.voidsetVpcSecurityGroupIds(List<String> value) A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getEnv, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validatePropertiesMethods inherited from class software.amazon.awscdk.CfnRefElement
getRefMethods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalIdMethods inherited from class software.constructs.Construct
getNode, isConstructMethods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSetMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface software.constructs.IConstruct
getNodeMethods inherited from interface software.amazon.awscdk.IEnvironmentAware
getEnvMethods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnCluster
protected CfnCluster(software.amazon.jsii.JsiiObjectRef objRef) -
CfnCluster
protected CfnCluster(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnCluster
@Stability(Stable) public CfnCluster(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnClusterProps props) - Parameters:
scope- Scope in which this resource is defined. This parameter is required.id- Construct identifier for this resource (unique in its scope). This parameter is required.props- Resource properties. This parameter is required.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspectin interfaceIInspectable- Parameters:
inspector- tree inspector to collect and process attributes. This parameter is required.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderPropertiesin classCfnResource- Parameters:
props- This parameter is required.
-
getAttrClusterNamespaceArn
The namespace Amazon Resource Name (ARN) of the cluster. -
getAttrDeferMaintenanceIdentifier
A unique identifier for the maintenance window. -
getAttrEndpointAddress
The connection endpoint for the Amazon Redshift cluster.For example:
examplecluster.cg034hpkmmjt.us-east-1.redshift.amazonaws.com. -
getAttrEndpointPort
The port number on which the Amazon Redshift cluster accepts connections.For example:
5439. -
getAttrId
-
getAttrMasterPasswordSecretArn
The Amazon Resource Name (ARN) for the cluster's admin user credentials secret. -
getCfnProperties
- Overrides:
getCfnPropertiesin classCfnResource
-
getClusterRef
A reference to a Cluster resource.- Specified by:
getClusterRefin interfaceIClusterRef
-
getTags
Tag Manager which manages the tags for this resource. -
getClusterType
The type of the cluster.When cluster type is specified as.
-
setClusterType
The type of the cluster.When cluster type is specified as.
-
getDbName
The name of the first database to be created when the cluster is created. -
setDbName
The name of the first database to be created when the cluster is created. -
getMasterUsername
The user name associated with the admin user account for the cluster that is being created. -
setMasterUsername
The user name associated with the admin user account for the cluster that is being created. -
getNodeType
The node type to be provisioned for the cluster. -
setNodeType
The node type to be provisioned for the cluster. -
getAllowVersionUpgrade
Iftrue, major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.Returns union: either
BooleanorIResolvable -
setAllowVersionUpgrade
Iftrue, major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster. -
setAllowVersionUpgrade
Iftrue, major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster. -
getAquaConfigurationStatus
This parameter is retired. -
setAquaConfigurationStatus
This parameter is retired. -
getAutomatedSnapshotRetentionPeriod
The number of days that automated snapshots are retained. -
setAutomatedSnapshotRetentionPeriod
The number of days that automated snapshots are retained. -
getAvailabilityZone
The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. -
setAvailabilityZone
The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. -
getAvailabilityZoneRelocation
The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is created.Returns union: either
BooleanorIResolvable -
setAvailabilityZoneRelocation
The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is created. -
setAvailabilityZoneRelocation
The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is created. -
getAvailabilityZoneRelocationStatus
Describes the status of the Availability Zone relocation operation. -
setAvailabilityZoneRelocationStatus
Describes the status of the Availability Zone relocation operation. -
getClassic
A boolean value indicating whether the resize operation is using the classic resize process.Returns union: either
BooleanorIResolvable -
setClassic
A boolean value indicating whether the resize operation is using the classic resize process. -
setClassic
A boolean value indicating whether the resize operation is using the classic resize process. -
getClusterIdentifier
A unique identifier for the cluster. -
setClusterIdentifier
A unique identifier for the cluster. -
getClusterParameterGroupName
The name of the parameter group to be associated with this cluster. -
setClusterParameterGroupName
The name of the parameter group to be associated with this cluster. -
getClusterSecurityGroups
A list of security groups to be associated with this cluster. -
setClusterSecurityGroups
A list of security groups to be associated with this cluster. -
getClusterSubnetGroupName
The name of a cluster subnet group to be associated with this cluster. -
setClusterSubnetGroupName
The name of a cluster subnet group to be associated with this cluster. -
getClusterVersion
The version of the Amazon Redshift engine software that you want to deploy on the cluster. -
setClusterVersion
The version of the Amazon Redshift engine software that you want to deploy on the cluster. -
getDeferMaintenance
A Boolean indicating whether to enable the deferred maintenance window.Returns union: either
BooleanorIResolvable -
setDeferMaintenance
A Boolean indicating whether to enable the deferred maintenance window. -
setDeferMaintenance
A Boolean indicating whether to enable the deferred maintenance window. -
getDeferMaintenanceDuration
An integer indicating the duration of the maintenance window in days. -
setDeferMaintenanceDuration
An integer indicating the duration of the maintenance window in days. -
getDeferMaintenanceEndTime
A timestamp for the end of the time period when we defer maintenance. -
setDeferMaintenanceEndTime
A timestamp for the end of the time period when we defer maintenance. -
getDeferMaintenanceStartTime
A timestamp indicating the start time for the deferred maintenance window. -
setDeferMaintenanceStartTime
A timestamp indicating the start time for the deferred maintenance window. -
getDestinationRegion
The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled. -
setDestinationRegion
The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled. -
getElasticIp
The Elastic IP (EIP) address for the cluster. -
setElasticIp
The Elastic IP (EIP) address for the cluster. -
getEncrypted
Iftrue, the data in the cluster is encrypted at rest.Returns union: either
BooleanorIResolvable -
setEncrypted
Iftrue, the data in the cluster is encrypted at rest. -
setEncrypted
Iftrue, the data in the cluster is encrypted at rest. -
getEndpoint
The connection endpoint.Returns union: either
IResolvableorCfnCluster.EndpointProperty -
setEndpoint
The connection endpoint. -
setEndpoint
The connection endpoint. -
getEnhancedVpcRouting
An option that specifies whether to create the cluster with enhanced VPC routing enabled.Returns union: either
BooleanorIResolvable -
setEnhancedVpcRouting
An option that specifies whether to create the cluster with enhanced VPC routing enabled. -
setEnhancedVpcRouting
An option that specifies whether to create the cluster with enhanced VPC routing enabled. -
getHsmClientCertificateIdentifier
Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM. -
setHsmClientCertificateIdentifier
Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM. -
getHsmConfigurationIdentifier
Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM. -
setHsmConfigurationIdentifier
Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM. -
getIamRoles
A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services. -
setIamRoles
A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services. -
getKmsKeyId
The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster. -
setKmsKeyId
The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster. -
getLoggingProperties
Specifies logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.Returns union: either
IResolvableorCfnCluster.LoggingPropertiesProperty -
setLoggingProperties
Specifies logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster. -
setLoggingProperties
@Stability(Stable) public void setLoggingProperties(@Nullable CfnCluster.LoggingPropertiesProperty value) Specifies logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster. -
getMaintenanceTrackName
An optional parameter for the name of the maintenance track for the cluster. -
setMaintenanceTrackName
An optional parameter for the name of the maintenance track for the cluster. -
getManageMasterPassword
Iftrue, Amazon Redshift uses AWS Secrets Manager to manage this cluster's admin credentials.Returns union: either
BooleanorIResolvable -
setManageMasterPassword
Iftrue, Amazon Redshift uses AWS Secrets Manager to manage this cluster's admin credentials. -
setManageMasterPassword
Iftrue, Amazon Redshift uses AWS Secrets Manager to manage this cluster's admin credentials. -
getManualSnapshotRetentionPeriod
The default number of days to retain a manual snapshot. -
setManualSnapshotRetentionPeriod
The default number of days to retain a manual snapshot. -
getMasterPasswordSecretKmsKeyId
The ID of the AWS Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret. -
setMasterPasswordSecretKmsKeyId
The ID of the AWS Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret. -
getMasterUserPassword
The password associated with the admin user account for the cluster that is being created. -
setMasterUserPassword
The password associated with the admin user account for the cluster that is being created. -
getMultiAz
A boolean indicating whether Amazon Redshift should deploy the cluster in two Availability Zones.Returns union: either
BooleanorIResolvable -
setMultiAz
A boolean indicating whether Amazon Redshift should deploy the cluster in two Availability Zones. -
setMultiAz
A boolean indicating whether Amazon Redshift should deploy the cluster in two Availability Zones. -
getNamespaceResourcePolicy
The policy that is attached to a resource. -
setNamespaceResourcePolicy
The policy that is attached to a resource. -
getNumberOfNodes
The number of compute nodes in the cluster. -
setNumberOfNodes
The number of compute nodes in the cluster. -
getOwnerAccount
The AWS account used to create or copy the snapshot. -
setOwnerAccount
The AWS account used to create or copy the snapshot. -
getPort
The port number on which the cluster accepts incoming connections. -
setPort
The port number on which the cluster accepts incoming connections. -
getPreferredMaintenanceWindow
The weekly time range (in UTC) during which automated cluster maintenance can occur. -
setPreferredMaintenanceWindow
The weekly time range (in UTC) during which automated cluster maintenance can occur. -
getPubliclyAccessible
Iftrue, the cluster can be accessed from a public network.Returns union: either
BooleanorIResolvable -
setPubliclyAccessible
Iftrue, the cluster can be accessed from a public network. -
setPubliclyAccessible
Iftrue, the cluster can be accessed from a public network. -
getResourceAction
The Amazon Redshift operation to be performed. -
setResourceAction
The Amazon Redshift operation to be performed. -
getRevisionTarget
Describes aRevisionTargetobject. -
setRevisionTarget
Describes aRevisionTargetobject. -
getRotateEncryptionKey
Rotates the encryption keys for a cluster.Returns union: either
BooleanorIResolvable -
setRotateEncryptionKey
Rotates the encryption keys for a cluster. -
setRotateEncryptionKey
Rotates the encryption keys for a cluster. -
getSnapshotClusterIdentifier
The name of the cluster the source snapshot was created from. -
setSnapshotClusterIdentifier
The name of the cluster the source snapshot was created from. -
getSnapshotCopyGrantName
The name of the snapshot copy grant. -
setSnapshotCopyGrantName
The name of the snapshot copy grant. -
getSnapshotCopyManual
Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots.Returns union: either
BooleanorIResolvable -
setSnapshotCopyManual
Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots. -
setSnapshotCopyManual
Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots. -
getSnapshotCopyRetentionPeriod
The number of days to retain automated snapshots in the destination AWS Region after they are copied from the source AWS Region . -
setSnapshotCopyRetentionPeriod
The number of days to retain automated snapshots in the destination AWS Region after they are copied from the source AWS Region . -
getSnapshotIdentifier
The name of the snapshot from which to create the new cluster. -
setSnapshotIdentifier
The name of the snapshot from which to create the new cluster. -
getTagsRaw
A list of tag instances. -
setTagsRaw
A list of tag instances. -
getVpcSecurityGroupIds
A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster. -
setVpcSecurityGroupIds
A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.
-