Package software.amazon.awscdk.services.redshift.alpha

Class ClusterProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.redshift.alpha.ClusterProps.Jsii$Proxy

All Implemented Interfaces:

ClusterProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

ClusterProps

@Stability(Experimental)
@Internal
public static final class ClusterProps.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements ClusterProps

An implementation for ClusterProps

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.redshift.alpha.ClusterProps

ClusterProps.Builder, ClusterProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(ClusterProps.Builder builder)	Constructor that initializes the object based on literal property values passed by the ClusterProps.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final Boolean	getAvailabilityZoneRelocation()	(experimental) Whether to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is created.
final Boolean	getClassicResizing()	(experimental) If this flag is set, the cluster resizing type will be set to classic.
final String	getClusterName()	(experimental) An optional identifier for the cluster.
final ClusterType	getClusterType()	(experimental) Settings for the individual instances that are launched.
final String	getDefaultDatabaseName()	(experimental) Name of a database which is automatically created inside the cluster.
final IRole	getDefaultRole()	(experimental) A single AWS Identity and Access Management (IAM) role to be used as the default role for the cluster.
final String	getElasticIp()	(experimental) The Elastic IP (EIP) address for the cluster.
final Boolean	getEncrypted()	(experimental) Whether to enable encryption of data at rest in the cluster.
final IKeyRef	getEncryptionKey()	(experimental) The KMS key to use for encryption of data at rest.
final Boolean	getEnhancedVpcRouting()	(experimental) If this flag is set, Amazon Redshift forces all COPY and UNLOAD traffic between your cluster and your data repositories through your virtual private cloud (VPC).
final LoggingProperties	getLoggingProperties()	(experimental) Bucket details for log files to be sent to, including prefix.
final MaintenanceTrackName	getMaintenanceTrackName()	(experimental) The maintenance track name for the cluster.
final Login	getMasterUser()	(experimental) Username and password for the administrative user.
final Boolean	getMultiAz()	(experimental) Indicating whether Amazon Redshift should deploy the cluster in two Availability Zones.
final NodeType	getNodeType()	(experimental) The node type to be provisioned for the cluster.
final Number	getNumberOfNodes()	(experimental) Number of compute nodes in the cluster.
final IClusterParameterGroup	getParameterGroup()	(experimental) Additional parameters to pass to the database engine https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html.
final Number	getPort()	(experimental) What port to listen on.
final String	getPreferredMaintenanceWindow()	(experimental) A preferred maintenance window day/time range.
final Boolean	getPubliclyAccessible()	(experimental) Whether to make cluster publicly accessible.
final Boolean	getRebootForParameterChanges()	(experimental) If this flag is set, the cluster will be rebooted when changes to the cluster's parameter group that require a restart to apply.
final RemovalPolicy	getRemovalPolicy()	(experimental) The removal policy to apply when the cluster and its instances are removed from the stack or replaced during an update.
final ResourceAction	getResourceAction()	(experimental) The Amazon Redshift operation to be performed.
final List<IRole>	getRoles()	(experimental) A list of AWS Identity and Access Management (IAM) role that can be used by the cluster to access other AWS services.
final List<ISecurityGroup>	getSecurityGroups()	(experimental) Security group.
final IClusterSubnetGroup	getSubnetGroup()	(experimental) A cluster subnet group to use with this cluster.
final IVpc	getVpc()	(experimental) The VPC to place the cluster in.
final SubnetSelection	getVpcSubnets()	(experimental) Where to place the instances within the VPC.
final int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(ClusterProps.Builder builder)

Constructor that initializes the object based on literal property values passed by the ClusterProps.Builder.

Method Details

getMasterUser

public final Login getMasterUser()

Description copied from interface: ClusterProps

(experimental) Username and password for the administrative user.

Specified by:

getMasterUser in interface ClusterProps

getVpc

public final IVpc getVpc()

Description copied from interface: ClusterProps

(experimental) The VPC to place the cluster in.

Specified by:

getVpc in interface ClusterProps

getAvailabilityZoneRelocation

public final Boolean getAvailabilityZoneRelocation()

Description copied from interface: ClusterProps

(experimental) Whether to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is created.

Default: - false

Specified by:

getAvailabilityZoneRelocation in interface ClusterProps

See Also:

• https://docs.aws.amazon.com/redshift/latest/mgmt/managing-cluster-recovery.html

getClassicResizing

public final Boolean getClassicResizing()

Description copied from interface: ClusterProps

(experimental) If this flag is set, the cluster resizing type will be set to classic.

When resizing a cluster, classic resizing will always provision a new cluster and transfer the data there.

Classic resize takes more time to complete, but it can be useful in cases where the change in node count or the node type to migrate to doesn't fall within the bounds for elastic resize.

Default: - Elastic resize type

Specified by:

getClassicResizing in interface ClusterProps

See Also:

• https://docs.aws.amazon.com/redshift/latest/mgmt/managing-cluster-operations.html#elastic-resize

getClusterName

public final String getClusterName()

Description copied from interface: ClusterProps

(experimental) An optional identifier for the cluster.

Default: - A name is automatically generated.

Specified by:

getClusterName in interface ClusterProps

getClusterType

public final ClusterType getClusterType()

Description copied from interface: ClusterProps

(experimental) Settings for the individual instances that are launched.

Default: `ClusterType.MULTI_NODE`

Specified by:

getClusterType in interface ClusterProps

getDefaultDatabaseName

public final String getDefaultDatabaseName()

Description copied from interface: ClusterProps

(experimental) Name of a database which is automatically created inside the cluster.

Default: - default_db

Specified by:

getDefaultDatabaseName in interface ClusterProps

getDefaultRole

public final IRole getDefaultRole()

Description copied from interface: ClusterProps

(experimental) A single AWS Identity and Access Management (IAM) role to be used as the default role for the cluster.

The default role must be included in the roles list.

Default: - No default role is specified for the cluster.

Specified by:

getDefaultRole in interface ClusterProps

getElasticIp

public final String getElasticIp()

Description copied from interface: ClusterProps

(experimental) The Elastic IP (EIP) address for the cluster.

Default: - No Elastic IP

Specified by:

getElasticIp in interface ClusterProps

See Also:

• https://docs.aws.amazon.com/redshift/latest/mgmt/managing-clusters-vpc.html

getEncrypted

public final Boolean getEncrypted()

Description copied from interface: ClusterProps

(experimental) Whether to enable encryption of data at rest in the cluster.

Default: true

Specified by:

getEncrypted in interface ClusterProps

getEncryptionKey

public final IKeyRef getEncryptionKey()

Description copied from interface: ClusterProps

(experimental) The KMS key to use for encryption of data at rest.

Default: - AWS-managed key, if encryption at rest is enabled

Specified by:

getEncryptionKey in interface ClusterProps

getEnhancedVpcRouting

public final Boolean getEnhancedVpcRouting()

Description copied from interface: ClusterProps

(experimental) If this flag is set, Amazon Redshift forces all COPY and UNLOAD traffic between your cluster and your data repositories through your virtual private cloud (VPC).

Default: - false

Specified by:

getEnhancedVpcRouting in interface ClusterProps

See Also:

• https://docs.aws.amazon.com/redshift/latest/mgmt/enhanced-vpc-routing.html

getLoggingProperties

public final LoggingProperties getLoggingProperties()

Description copied from interface: ClusterProps

(experimental) Bucket details for log files to be sent to, including prefix.

Default: - No logging bucket is used

Specified by:

getLoggingProperties in interface ClusterProps

getMaintenanceTrackName

public final MaintenanceTrackName getMaintenanceTrackName()

Description copied from interface: ClusterProps

(experimental) The maintenance track name for the cluster.

Default: undefined - Redshift default is current

Specified by:

getMaintenanceTrackName in interface ClusterProps

See Also:

• https://docs.aws.amazon.com/redshift/latest/mgmt/managing-cluster-considerations.html#rs-mgmt-maintenance-tracks

getMultiAz

public final Boolean getMultiAz()

Description copied from interface: ClusterProps

(experimental) Indicating whether Amazon Redshift should deploy the cluster in two Availability Zones.

Default: - false

Specified by:

getMultiAz in interface ClusterProps

getNodeType

public final NodeType getNodeType()

Description copied from interface: ClusterProps

(experimental) The node type to be provisioned for the cluster.

Default: `NodeType.DC2_LARGE`

Specified by:

getNodeType in interface ClusterProps

getNumberOfNodes

public final Number getNumberOfNodes()

Description copied from interface: ClusterProps

(experimental) Number of compute nodes in the cluster. Only specify this property for multi-node clusters.

Value must be at least 2 and no more than 100.

Default: - 2 if `clusterType` is ClusterType.MULTI_NODE, undefined otherwise

Specified by:

getNumberOfNodes in interface ClusterProps

getParameterGroup

public final IClusterParameterGroup getParameterGroup()

Description copied from interface: ClusterProps

(experimental) Additional parameters to pass to the database engine https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html.

Default: - No parameter group.

Specified by:

getParameterGroup in interface ClusterProps

getPort

public final Number getPort()

Description copied from interface: ClusterProps

(experimental) What port to listen on.

Default: - The default for the engine is used.

Specified by:

getPort in interface ClusterProps

getPreferredMaintenanceWindow

public final String getPreferredMaintenanceWindow()

Description copied from interface: ClusterProps

(experimental) A preferred maintenance window day/time range. Should be specified as a range ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC).

Example: 'Sun:23:45-Mon:00:15'

Default: - 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week.

Specified by:

getPreferredMaintenanceWindow in interface ClusterProps

See Also:

• https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#Concepts.DBMaintenance

getPubliclyAccessible

public final Boolean getPubliclyAccessible()

Description copied from interface: ClusterProps

(experimental) Whether to make cluster publicly accessible.

Default: false

Specified by:

getPubliclyAccessible in interface ClusterProps

getRebootForParameterChanges

public final Boolean getRebootForParameterChanges()

Description copied from interface: ClusterProps

(experimental) If this flag is set, the cluster will be rebooted when changes to the cluster's parameter group that require a restart to apply.

Default: false

Specified by:

getRebootForParameterChanges in interface ClusterProps

getRemovalPolicy

public final RemovalPolicy getRemovalPolicy()

Description copied from interface: ClusterProps

(experimental) The removal policy to apply when the cluster and its instances are removed from the stack or replaced during an update.

Default: RemovalPolicy.RETAIN

Specified by:

getRemovalPolicy in interface ClusterProps

getResourceAction

public final ResourceAction getResourceAction()

Description copied from interface: ClusterProps

(experimental) The Amazon Redshift operation to be performed.

Default: - no operation

Specified by:

getResourceAction in interface ClusterProps

getRoles

public final List<IRole> getRoles()

Description copied from interface: ClusterProps

(experimental) A list of AWS Identity and Access Management (IAM) role that can be used by the cluster to access other AWS services.

The maximum number of roles to attach to a cluster is subject to a quota.

Default: - No role is attached to the cluster.

Specified by:

getRoles in interface ClusterProps

getSecurityGroups

public final List<ISecurityGroup> getSecurityGroups()

Description copied from interface: ClusterProps

(experimental) Security group.

Default: - a new security group is created.

Specified by:

getSecurityGroups in interface ClusterProps

getSubnetGroup

public final IClusterSubnetGroup getSubnetGroup()

Description copied from interface: ClusterProps

(experimental) A cluster subnet group to use with this cluster.

Default: - a new subnet group will be created.

Specified by:

getSubnetGroup in interface ClusterProps

getVpcSubnets

public final SubnetSelection getVpcSubnets()

Description copied from interface: ClusterProps

(experimental) Where to place the instances within the VPC.

Default: - private subnets

Specified by:

getVpcSubnets in interface ClusterProps

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object