CfnClusterPropsMixin

class aws_cdk.mixins_preview.aws_redshift.mixins.CfnClusterPropsMixin(props, *, strategy=None)

Bases: Mixin

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 .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html
CloudformationResource:: AWS::Redshift::Cluster
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_redshift import mixins as redshift_mixins

# namespace_resource_policy: Any

cfn_cluster_props_mixin = redshift_mixins.CfnClusterPropsMixin(redshift_mixins.CfnClusterMixinProps(
    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_type="clusterType",
    cluster_version="clusterVersion",
    db_name="dbName",
    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_mixins.CfnClusterPropsMixin.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_mixins.CfnClusterPropsMixin.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_username="masterUsername",
    master_user_password="masterUserPassword",
    multi_az=False,
    namespace_resource_policy=namespace_resource_policy,
    node_type="nodeType",
    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"]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::Redshift::Cluster.

Parameters:

props (Union[CfnClusterMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['allowVersionUpgrade', 'aquaConfigurationStatus', 'automatedSnapshotRetentionPeriod', 'availabilityZone', 'availabilityZoneRelocation', 'availabilityZoneRelocationStatus', 'classic', 'clusterIdentifier', 'clusterParameterGroupName', 'clusterSecurityGroups', 'clusterSubnetGroupName', 'clusterType', 'clusterVersion', 'dbName', 'deferMaintenance', 'deferMaintenanceDuration', 'deferMaintenanceEndTime', 'deferMaintenanceStartTime', 'destinationRegion', 'elasticIp', 'encrypted', 'endpoint', 'enhancedVpcRouting', 'hsmClientCertificateIdentifier', 'hsmConfigurationIdentifier', 'iamRoles', 'kmsKeyId', 'loggingProperties', 'maintenanceTrackName', 'manageMasterPassword', 'manualSnapshotRetentionPeriod', 'masterPasswordSecretKmsKeyId', 'masterUsername', 'masterUserPassword', 'multiAz', 'namespaceResourcePolicy', 'nodeType', 'numberOfNodes', 'ownerAccount', 'port', 'preferredMaintenanceWindow', 'publiclyAccessible', 'resourceAction', 'revisionTarget', 'rotateEncryptionKey', 'snapshotClusterIdentifier', 'snapshotCopyGrantName', 'snapshotCopyManual', 'snapshotCopyRetentionPeriod', 'snapshotIdentifier', 'tags', 'vpcSecurityGroupIds']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

EndpointProperty

class CfnClusterPropsMixin.EndpointProperty(*, address=None, port=None)

Bases: object

Describes a connection endpoint.

Parameters:

address (Optional[str]) – The DNS address of the cluster. This property is read only.
port (Optional[str]) – The port that the database engine is listening on. This property is read only.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-cluster-endpoint.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_redshift import mixins as redshift_mixins

endpoint_property = redshift_mixins.CfnClusterPropsMixin.EndpointProperty(
    address="address",
    port="port"
)

Attributes

address

The DNS address of the cluster.

This property is read only.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-cluster-endpoint.html#cfn-redshift-cluster-endpoint-address

port

The port that the database engine is listening on.

This property is read only.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-cluster-endpoint.html#cfn-redshift-cluster-endpoint-port

LoggingPropertiesProperty

class CfnClusterPropsMixin.LoggingPropertiesProperty(*, bucket_name=None, log_destination_type=None, log_exports=None, s3_key_prefix=None)

Bases: object

Specifies logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.

Parameters:

bucket_name (Optional[str]) – The name of an existing S3 bucket where the log files are to be stored. Constraints: - Must be in the same region as the cluster - The cluster must have read bucket and put object permissions
log_destination_type (Optional[str]) – The log destination type. An enum with possible values of s3 and cloudwatch .
log_exports (Optional[Sequence[str]]) – The collection of exported log types. Possible values are connectionlog , useractivitylog , and userlog .
s3_key_prefix (Optional[str]) – The prefix applied to the log file names. Valid characters are any letter from any language, any whitespace character, any numeric character, and the following characters: underscore ( _ ), period ( . ), colon ( : ), slash ( / ), equal ( = ), plus ( + ), backslash ( \ ), hyphen ( - ), at symbol ( @ ).

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-cluster-loggingproperties.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_redshift import mixins as redshift_mixins

logging_properties_property = redshift_mixins.CfnClusterPropsMixin.LoggingPropertiesProperty(
    bucket_name="bucketName",
    log_destination_type="logDestinationType",
    log_exports=["logExports"],
    s3_key_prefix="s3KeyPrefix"
)

Attributes

bucket_name

The name of an existing S3 bucket where the log files are to be stored.

Constraints:

Must be in the same region as the cluster
The cluster must have read bucket and put object permissions

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-cluster-loggingproperties.html#cfn-redshift-cluster-loggingproperties-bucketname

log_destination_type

The log destination type.

An enum with possible values of s3 and cloudwatch .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-cluster-loggingproperties.html#cfn-redshift-cluster-loggingproperties-logdestinationtype

log_exports

The collection of exported log types.

Possible values are connectionlog , useractivitylog , and userlog .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-cluster-loggingproperties.html#cfn-redshift-cluster-loggingproperties-logexports

s3_key_prefix

The prefix applied to the log file names.

Valid characters are any letter from any language, any whitespace character, any numeric character, and the following characters: underscore ( _ ), period ( . ), colon ( : ), slash ( / ), equal ( = ), plus ( + ), backslash ( \ ), hyphen ( - ), at symbol ( @ ).

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-cluster-loggingproperties.html#cfn-redshift-cluster-loggingproperties-s3keyprefix