AWS Cloud Control v1.9.0, Nov 18 24

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi

pulumi/pulumi-aws-native

aws-native.redshift.getCluster

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi

pulumi/pulumi-aws-native

Using getCluster

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getCluster(args: GetClusterArgs, opts?: InvokeOptions): Promise<GetClusterResult>
function getClusterOutput(args: GetClusterOutputArgs, opts?: InvokeOptions): Output<GetClusterResult>

def get_cluster(cluster_identifier: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetClusterResult
def get_cluster_output(cluster_identifier: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetClusterResult]

func LookupCluster(ctx *Context, args *LookupClusterArgs, opts ...InvokeOption) (*LookupClusterResult, error)
func LookupClusterOutput(ctx *Context, args *LookupClusterOutputArgs, opts ...InvokeOption) LookupClusterResultOutput

> Note: This function is named LookupCluster in the Go SDK.

public static class GetCluster 
{
    public static Task<GetClusterResult> InvokeAsync(GetClusterArgs args, InvokeOptions? opts = null)
    public static Output<GetClusterResult> Invoke(GetClusterInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetClusterResult> getCluster(GetClusterArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: aws-native:redshift:getCluster
  arguments:
    # arguments dictionary

The following arguments are supported:

ClusterIdentifier string: A unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. All alphabetical characters must be lower case, no hypens at the end, no two consecutive hyphens. Cluster name should be unique for all clusters within an AWS account

ClusterIdentifier string: A unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. All alphabetical characters must be lower case, no hypens at the end, no two consecutive hyphens. Cluster name should be unique for all clusters within an AWS account

clusterIdentifier String: A unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. All alphabetical characters must be lower case, no hypens at the end, no two consecutive hyphens. Cluster name should be unique for all clusters within an AWS account

clusterIdentifier string: A unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. All alphabetical characters must be lower case, no hypens at the end, no two consecutive hyphens. Cluster name should be unique for all clusters within an AWS account

cluster_identifier str: A unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. All alphabetical characters must be lower case, no hypens at the end, no two consecutive hyphens. Cluster name should be unique for all clusters within an AWS account

clusterIdentifier String: A unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. All alphabetical characters must be lower case, no hypens at the end, no two consecutive hyphens. Cluster name should be unique for all clusters within an AWS account

getCluster Result

The following output properties are available:

AllowVersionUpgrade bool

Major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster. Default value is True

AquaConfigurationStatus string

The value represents how the cluster is configured to use AQUA (Advanced Query Accelerator) after the cluster is restored. Possible values include the following.

enabled - Use AQUA if it is available for the current Region and Amazon Redshift node type. disabled - Don't use AQUA. auto - Amazon Redshift determines whether to use AQUA.

AutomatedSnapshotRetentionPeriod int

The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Default value is 1

AvailabilityZone string

The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint

AvailabilityZoneRelocation bool

The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster modification is complete.

AvailabilityZoneRelocationStatus string

The availability zone relocation status of the cluster

ClusterNamespaceArn string

The Amazon Resource Name (ARN) of the cluster namespace.

ClusterParameterGroupName string

The name of the parameter group to be associated with this cluster.

ClusterSecurityGroups List<string>

A list of security groups to be associated with this cluster.

ClusterType string

The type of the cluster. When cluster type is specified as single-node, the NumberOfNodes parameter is not required and if multi-node, the NumberOfNodes parameter is required

ClusterVersion string

The version of the Amazon Redshift engine software that you want to deploy on the cluster.The version selected runs on all the nodes in the cluster.

DeferMaintenanceEndTime string

A timestamp indicating end time for the deferred maintenance window. If you specify an end time, you can't specify a duration.

DeferMaintenanceIdentifier string

A unique identifier for the deferred maintenance window.

DeferMaintenanceStartTime string

A timestamp indicating the start time for the deferred maintenance window.

DestinationRegion string

The destination AWS Region that you want to copy snapshots to. Constraints: Must be the name of a valid AWS Region. For more information, see Regions and Endpoints in the Amazon Web Services [https://docs.aws.amazon.com/general/latest/gr/rande.html#redshift_region] General Reference

ElasticIp string

The Elastic IP (EIP) address for the cluster.

Encrypted bool

If true, the data in the cluster is encrypted at rest.

Endpoint Pulumi.AwsNative.Redshift.Outputs.ClusterEndpoint

The connection endpoint.

EnhancedVpcRouting bool

An option that specifies whether to create the cluster with enhanced VPC routing enabled. 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

HsmClientCertificateIdentifier string

Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM

HsmConfigurationIdentifier string

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.

IamRoles List<string>

A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services. You must supply the IAM roles in their Amazon Resource Name (ARN) format. You can supply up to 50 IAM roles in a single request

KmsKeyId string

The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.

LoggingProperties Pulumi.AwsNative.Redshift.Outputs.ClusterLoggingProperties

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

MaintenanceTrackName string

The name for the maintenance track that you want to assign for the cluster. This name change is asynchronous. The new track name stays in the PendingModifiedValues for the cluster until the next maintenance window. When the maintenance track changes, the cluster is switched to the latest cluster release available for the maintenance track. At this point, the maintenance track name is applied.

ManualSnapshotRetentionPeriod int

The number of days to retain newly copied snapshots in the destination AWS Region after they are copied from the source AWS Region. If the value is -1, the manual snapshot is retained indefinitely.

The value must be either -1 or an integer between 1 and 3,653.

MasterPasswordSecretArn string

The Amazon Resource Name (ARN) for the cluster's admin user credentials secret.

MasterPasswordSecretKmsKeyId string

The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin user credentials secret.

MultiAz bool

A boolean indicating if the redshift cluster is multi-az or not. If you don't provide this parameter or set the value to false, the redshift cluster will be single-az.

NamespaceResourcePolicy object

The namespace resource policy document that will be attached to a Redshift cluster.

Search the CloudFormation User Guide for AWS::Redshift::Cluster for more information about the expected schema for this property.

NodeType string

NumberOfNodes int

The number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as multi-node.

Port int

The port number on which the cluster accepts incoming connections. The cluster is accessible only via the JDBC and ODBC connection strings

PreferredMaintenanceWindow string

The weekly time range (in UTC) during which automated cluster maintenance can occur.

PubliclyAccessible bool

If true, the cluster can be accessed from a public network.

ResourceAction string

The Redshift operation to be performed. Resource Action supports pause-cluster, resume-cluster, failover-primary-compute APIs

RevisionTarget string

The identifier of the database revision. You can retrieve this value from the response to the DescribeClusterDbRevisions request.

RotateEncryptionKey bool

A boolean indicating if we want to rotate Encryption Keys.

SnapshotCopyGrantName string

The name of the snapshot copy grant to use when snapshots of an AWS KMS-encrypted cluster are copied to the destination region.

SnapshotCopyManual bool

Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots.

SnapshotCopyRetentionPeriod int

The number of days to retain automated snapshots in the destination region after they are copied from the source region.

Default is 7.

Constraints: Must be at least 1 and no more than 35.

Tags List<Pulumi.AwsNative.Outputs.Tag>

The list of tags for the cluster parameter group.

VpcSecurityGroupIds List<string>

A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.

AllowVersionUpgrade bool

Major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster. Default value is True

AquaConfigurationStatus string

The value represents how the cluster is configured to use AQUA (Advanced Query Accelerator) after the cluster is restored. Possible values include the following.

enabled - Use AQUA if it is available for the current Region and Amazon Redshift node type. disabled - Don't use AQUA. auto - Amazon Redshift determines whether to use AQUA.

AutomatedSnapshotRetentionPeriod int

The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Default value is 1

AvailabilityZone string

The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint

AvailabilityZoneRelocation bool

The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster modification is complete.

AvailabilityZoneRelocationStatus string

The availability zone relocation status of the cluster

ClusterNamespaceArn string

The Amazon Resource Name (ARN) of the cluster namespace.

ClusterParameterGroupName string

The name of the parameter group to be associated with this cluster.

ClusterSecurityGroups []string

A list of security groups to be associated with this cluster.

ClusterType string

The type of the cluster. When cluster type is specified as single-node, the NumberOfNodes parameter is not required and if multi-node, the NumberOfNodes parameter is required

ClusterVersion string

The version of the Amazon Redshift engine software that you want to deploy on the cluster.The version selected runs on all the nodes in the cluster.

DeferMaintenanceEndTime string

A timestamp indicating end time for the deferred maintenance window. If you specify an end time, you can't specify a duration.

DeferMaintenanceIdentifier string

A unique identifier for the deferred maintenance window.

DeferMaintenanceStartTime string

A timestamp indicating the start time for the deferred maintenance window.

DestinationRegion string

ElasticIp string

The Elastic IP (EIP) address for the cluster.

Encrypted bool

If true, the data in the cluster is encrypted at rest.

Endpoint ClusterEndpoint

The connection endpoint.

EnhancedVpcRouting bool

If this option is true , enhanced VPC routing is enabled.

Default: false

HsmClientCertificateIdentifier string

Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM

HsmConfigurationIdentifier string

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.

IamRoles []string

KmsKeyId string

The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.

LoggingProperties ClusterLoggingProperties

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

MaintenanceTrackName string

ManualSnapshotRetentionPeriod int

The number of days to retain newly copied snapshots in the destination AWS Region after they are copied from the source AWS Region. If the value is -1, the manual snapshot is retained indefinitely.

The value must be either -1 or an integer between 1 and 3,653.

MasterPasswordSecretArn string

The Amazon Resource Name (ARN) for the cluster's admin user credentials secret.

MasterPasswordSecretKmsKeyId string

The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin user credentials secret.

MultiAz bool

A boolean indicating if the redshift cluster is multi-az or not. If you don't provide this parameter or set the value to false, the redshift cluster will be single-az.

NamespaceResourcePolicy interface{}

The namespace resource policy document that will be attached to a Redshift cluster.

Search the CloudFormation User Guide for AWS::Redshift::Cluster for more information about the expected schema for this property.

NodeType string

NumberOfNodes int

The number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as multi-node.

Port int

The port number on which the cluster accepts incoming connections. The cluster is accessible only via the JDBC and ODBC connection strings

PreferredMaintenanceWindow string

The weekly time range (in UTC) during which automated cluster maintenance can occur.

PubliclyAccessible bool

If true, the cluster can be accessed from a public network.

ResourceAction string

The Redshift operation to be performed. Resource Action supports pause-cluster, resume-cluster, failover-primary-compute APIs

RevisionTarget string

The identifier of the database revision. You can retrieve this value from the response to the DescribeClusterDbRevisions request.

RotateEncryptionKey bool

A boolean indicating if we want to rotate Encryption Keys.

SnapshotCopyGrantName string

The name of the snapshot copy grant to use when snapshots of an AWS KMS-encrypted cluster are copied to the destination region.

SnapshotCopyManual bool

Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots.

SnapshotCopyRetentionPeriod int

The number of days to retain automated snapshots in the destination region after they are copied from the source region.

Default is 7.

Constraints: Must be at least 1 and no more than 35.

Tags Tag

The list of tags for the cluster parameter group.

VpcSecurityGroupIds []string

A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.

allowVersionUpgrade Boolean

Major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster. Default value is True

aquaConfigurationStatus String

The value represents how the cluster is configured to use AQUA (Advanced Query Accelerator) after the cluster is restored. Possible values include the following.

enabled - Use AQUA if it is available for the current Region and Amazon Redshift node type. disabled - Don't use AQUA. auto - Amazon Redshift determines whether to use AQUA.

automatedSnapshotRetentionPeriod Integer

The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Default value is 1

availabilityZone String

The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint

availabilityZoneRelocation Boolean

The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster modification is complete.

availabilityZoneRelocationStatus String

The availability zone relocation status of the cluster

clusterNamespaceArn String

The Amazon Resource Name (ARN) of the cluster namespace.

clusterParameterGroupName String

The name of the parameter group to be associated with this cluster.

clusterSecurityGroups List<String>

A list of security groups to be associated with this cluster.

clusterType String

The type of the cluster. When cluster type is specified as single-node, the NumberOfNodes parameter is not required and if multi-node, the NumberOfNodes parameter is required

clusterVersion String

The version of the Amazon Redshift engine software that you want to deploy on the cluster.The version selected runs on all the nodes in the cluster.

deferMaintenanceEndTime String

A timestamp indicating end time for the deferred maintenance window. If you specify an end time, you can't specify a duration.

deferMaintenanceIdentifier String

A unique identifier for the deferred maintenance window.

deferMaintenanceStartTime String

A timestamp indicating the start time for the deferred maintenance window.

destinationRegion String

elasticIp String

The Elastic IP (EIP) address for the cluster.

encrypted Boolean

If true, the data in the cluster is encrypted at rest.

endpoint ClusterEndpoint

The connection endpoint.

enhancedVpcRouting Boolean

If this option is true , enhanced VPC routing is enabled.

Default: false

hsmClientCertificateIdentifier String

Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM

hsmConfigurationIdentifier String

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.

iamRoles List<String>

kmsKeyId String

The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.

loggingProperties ClusterLoggingProperties

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

maintenanceTrackName String

manualSnapshotRetentionPeriod Integer

The number of days to retain newly copied snapshots in the destination AWS Region after they are copied from the source AWS Region. If the value is -1, the manual snapshot is retained indefinitely.

The value must be either -1 or an integer between 1 and 3,653.

masterPasswordSecretArn String

The Amazon Resource Name (ARN) for the cluster's admin user credentials secret.

masterPasswordSecretKmsKeyId String

The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin user credentials secret.

multiAz Boolean

A boolean indicating if the redshift cluster is multi-az or not. If you don't provide this parameter or set the value to false, the redshift cluster will be single-az.

namespaceResourcePolicy Object

The namespace resource policy document that will be attached to a Redshift cluster.

Search the CloudFormation User Guide for AWS::Redshift::Cluster for more information about the expected schema for this property.

nodeType String

numberOfNodes Integer

The number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as multi-node.

port Integer

The port number on which the cluster accepts incoming connections. The cluster is accessible only via the JDBC and ODBC connection strings

preferredMaintenanceWindow String

The weekly time range (in UTC) during which automated cluster maintenance can occur.

publiclyAccessible Boolean

If true, the cluster can be accessed from a public network.

resourceAction String

The Redshift operation to be performed. Resource Action supports pause-cluster, resume-cluster, failover-primary-compute APIs

revisionTarget String

The identifier of the database revision. You can retrieve this value from the response to the DescribeClusterDbRevisions request.

rotateEncryptionKey Boolean

A boolean indicating if we want to rotate Encryption Keys.

snapshotCopyGrantName String

The name of the snapshot copy grant to use when snapshots of an AWS KMS-encrypted cluster are copied to the destination region.

snapshotCopyManual Boolean

Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots.

snapshotCopyRetentionPeriod Integer

The number of days to retain automated snapshots in the destination region after they are copied from the source region.

Default is 7.

Constraints: Must be at least 1 and no more than 35.

tags List<Tag>

The list of tags for the cluster parameter group.

vpcSecurityGroupIds List<String>

A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.

allowVersionUpgrade boolean

Major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster. Default value is True

aquaConfigurationStatus string

The value represents how the cluster is configured to use AQUA (Advanced Query Accelerator) after the cluster is restored. Possible values include the following.

enabled - Use AQUA if it is available for the current Region and Amazon Redshift node type. disabled - Don't use AQUA. auto - Amazon Redshift determines whether to use AQUA.

automatedSnapshotRetentionPeriod number

The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Default value is 1

availabilityZone string

The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint

availabilityZoneRelocation boolean

The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster modification is complete.

availabilityZoneRelocationStatus string

The availability zone relocation status of the cluster

clusterNamespaceArn string

The Amazon Resource Name (ARN) of the cluster namespace.

clusterParameterGroupName string

The name of the parameter group to be associated with this cluster.

clusterSecurityGroups string[]

A list of security groups to be associated with this cluster.

clusterType string

The type of the cluster. When cluster type is specified as single-node, the NumberOfNodes parameter is not required and if multi-node, the NumberOfNodes parameter is required

clusterVersion string

The version of the Amazon Redshift engine software that you want to deploy on the cluster.The version selected runs on all the nodes in the cluster.

deferMaintenanceEndTime string

A timestamp indicating end time for the deferred maintenance window. If you specify an end time, you can't specify a duration.

deferMaintenanceIdentifier string

A unique identifier for the deferred maintenance window.

deferMaintenanceStartTime string

A timestamp indicating the start time for the deferred maintenance window.

destinationRegion string

elasticIp string

The Elastic IP (EIP) address for the cluster.

encrypted boolean

If true, the data in the cluster is encrypted at rest.

endpoint ClusterEndpoint

The connection endpoint.

enhancedVpcRouting boolean

If this option is true , enhanced VPC routing is enabled.

Default: false

hsmClientCertificateIdentifier string

Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM

hsmConfigurationIdentifier string

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.

iamRoles string[]

kmsKeyId string

The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.

loggingProperties ClusterLoggingProperties

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

maintenanceTrackName string

manualSnapshotRetentionPeriod number

The number of days to retain newly copied snapshots in the destination AWS Region after they are copied from the source AWS Region. If the value is -1, the manual snapshot is retained indefinitely.

The value must be either -1 or an integer between 1 and 3,653.

masterPasswordSecretArn string

The Amazon Resource Name (ARN) for the cluster's admin user credentials secret.

masterPasswordSecretKmsKeyId string

The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin user credentials secret.

multiAz boolean

A boolean indicating if the redshift cluster is multi-az or not. If you don't provide this parameter or set the value to false, the redshift cluster will be single-az.

namespaceResourcePolicy any

The namespace resource policy document that will be attached to a Redshift cluster.

Search the CloudFormation User Guide for AWS::Redshift::Cluster for more information about the expected schema for this property.

nodeType string

numberOfNodes number

The number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as multi-node.

port number

The port number on which the cluster accepts incoming connections. The cluster is accessible only via the JDBC and ODBC connection strings

preferredMaintenanceWindow string

The weekly time range (in UTC) during which automated cluster maintenance can occur.

publiclyAccessible boolean

If true, the cluster can be accessed from a public network.

resourceAction string

The Redshift operation to be performed. Resource Action supports pause-cluster, resume-cluster, failover-primary-compute APIs

revisionTarget string

The identifier of the database revision. You can retrieve this value from the response to the DescribeClusterDbRevisions request.

rotateEncryptionKey boolean

A boolean indicating if we want to rotate Encryption Keys.

snapshotCopyGrantName string

The name of the snapshot copy grant to use when snapshots of an AWS KMS-encrypted cluster are copied to the destination region.

snapshotCopyManual boolean

Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots.

snapshotCopyRetentionPeriod number

The number of days to retain automated snapshots in the destination region after they are copied from the source region.

Default is 7.

Constraints: Must be at least 1 and no more than 35.

tags Tag[]

The list of tags for the cluster parameter group.

vpcSecurityGroupIds string[]

A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.

allow_version_upgrade bool

Major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster. Default value is True

aqua_configuration_status str

The value represents how the cluster is configured to use AQUA (Advanced Query Accelerator) after the cluster is restored. Possible values include the following.

enabled - Use AQUA if it is available for the current Region and Amazon Redshift node type. disabled - Don't use AQUA. auto - Amazon Redshift determines whether to use AQUA.

automated_snapshot_retention_period int

The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Default value is 1

availability_zone str

The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint

availability_zone_relocation bool

The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster modification is complete.

availability_zone_relocation_status str

The availability zone relocation status of the cluster

cluster_namespace_arn str

The Amazon Resource Name (ARN) of the cluster namespace.

cluster_parameter_group_name str

The name of the parameter group to be associated with this cluster.

cluster_security_groups Sequence[str]

A list of security groups to be associated with this cluster.

cluster_type str

The type of the cluster. When cluster type is specified as single-node, the NumberOfNodes parameter is not required and if multi-node, the NumberOfNodes parameter is required

cluster_version str

The version of the Amazon Redshift engine software that you want to deploy on the cluster.The version selected runs on all the nodes in the cluster.

defer_maintenance_end_time str

A timestamp indicating end time for the deferred maintenance window. If you specify an end time, you can't specify a duration.

defer_maintenance_identifier str

A unique identifier for the deferred maintenance window.

defer_maintenance_start_time str

A timestamp indicating the start time for the deferred maintenance window.

destination_region str

elastic_ip str

The Elastic IP (EIP) address for the cluster.

encrypted bool

If true, the data in the cluster is encrypted at rest.

endpoint ClusterEndpoint

The connection endpoint.

enhanced_vpc_routing bool

If this option is true , enhanced VPC routing is enabled.

Default: false

hsm_client_certificate_identifier str

Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM

hsm_configuration_identifier str

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.

iam_roles Sequence[str]

kms_key_id str

The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.

logging_properties ClusterLoggingProperties

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

maintenance_track_name str

manual_snapshot_retention_period int

The number of days to retain newly copied snapshots in the destination AWS Region after they are copied from the source AWS Region. If the value is -1, the manual snapshot is retained indefinitely.

The value must be either -1 or an integer between 1 and 3,653.

master_password_secret_arn str

The Amazon Resource Name (ARN) for the cluster's admin user credentials secret.

master_password_secret_kms_key_id str

The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin user credentials secret.

multi_az bool

A boolean indicating if the redshift cluster is multi-az or not. If you don't provide this parameter or set the value to false, the redshift cluster will be single-az.

namespace_resource_policy Any

The namespace resource policy document that will be attached to a Redshift cluster.

Search the CloudFormation User Guide for AWS::Redshift::Cluster for more information about the expected schema for this property.

node_type str

number_of_nodes int

The number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as multi-node.

port int

The port number on which the cluster accepts incoming connections. The cluster is accessible only via the JDBC and ODBC connection strings

preferred_maintenance_window str

The weekly time range (in UTC) during which automated cluster maintenance can occur.

publicly_accessible bool

If true, the cluster can be accessed from a public network.

resource_action str

The Redshift operation to be performed. Resource Action supports pause-cluster, resume-cluster, failover-primary-compute APIs

revision_target str

The identifier of the database revision. You can retrieve this value from the response to the DescribeClusterDbRevisions request.

rotate_encryption_key bool

A boolean indicating if we want to rotate Encryption Keys.

snapshot_copy_grant_name str

The name of the snapshot copy grant to use when snapshots of an AWS KMS-encrypted cluster are copied to the destination region.

snapshot_copy_manual bool

Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots.

snapshot_copy_retention_period int

The number of days to retain automated snapshots in the destination region after they are copied from the source region.

Default is 7.

Constraints: Must be at least 1 and no more than 35.

tags Sequence[root_Tag]

The list of tags for the cluster parameter group.

vpc_security_group_ids Sequence[str]

A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.

allowVersionUpgrade Boolean

Major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster. Default value is True

aquaConfigurationStatus String

The value represents how the cluster is configured to use AQUA (Advanced Query Accelerator) after the cluster is restored. Possible values include the following.

enabled - Use AQUA if it is available for the current Region and Amazon Redshift node type. disabled - Don't use AQUA. auto - Amazon Redshift determines whether to use AQUA.

automatedSnapshotRetentionPeriod Number

The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Default value is 1

availabilityZone String

The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint

availabilityZoneRelocation Boolean

The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster modification is complete.

availabilityZoneRelocationStatus String

The availability zone relocation status of the cluster

clusterNamespaceArn String

The Amazon Resource Name (ARN) of the cluster namespace.

clusterParameterGroupName String

The name of the parameter group to be associated with this cluster.

clusterSecurityGroups List<String>

A list of security groups to be associated with this cluster.

clusterType String

The type of the cluster. When cluster type is specified as single-node, the NumberOfNodes parameter is not required and if multi-node, the NumberOfNodes parameter is required

clusterVersion String

The version of the Amazon Redshift engine software that you want to deploy on the cluster.The version selected runs on all the nodes in the cluster.

deferMaintenanceEndTime String

A timestamp indicating end time for the deferred maintenance window. If you specify an end time, you can't specify a duration.

deferMaintenanceIdentifier String

A unique identifier for the deferred maintenance window.

deferMaintenanceStartTime String

A timestamp indicating the start time for the deferred maintenance window.

destinationRegion String

elasticIp String

The Elastic IP (EIP) address for the cluster.

encrypted Boolean

If true, the data in the cluster is encrypted at rest.

endpoint Property Map

The connection endpoint.

enhancedVpcRouting Boolean

If this option is true , enhanced VPC routing is enabled.

Default: false

hsmClientCertificateIdentifier String

Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM

hsmConfigurationIdentifier String

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.

iamRoles List<String>

kmsKeyId String

The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.

loggingProperties Property Map

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

maintenanceTrackName String

manualSnapshotRetentionPeriod Number

The number of days to retain newly copied snapshots in the destination AWS Region after they are copied from the source AWS Region. If the value is -1, the manual snapshot is retained indefinitely.

The value must be either -1 or an integer between 1 and 3,653.

masterPasswordSecretArn String

The Amazon Resource Name (ARN) for the cluster's admin user credentials secret.

masterPasswordSecretKmsKeyId String

The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin user credentials secret.

multiAz Boolean

A boolean indicating if the redshift cluster is multi-az or not. If you don't provide this parameter or set the value to false, the redshift cluster will be single-az.

namespaceResourcePolicy Any

The namespace resource policy document that will be attached to a Redshift cluster.

Search the CloudFormation User Guide for AWS::Redshift::Cluster for more information about the expected schema for this property.

nodeType String

numberOfNodes Number

The number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as multi-node.

port Number

The port number on which the cluster accepts incoming connections. The cluster is accessible only via the JDBC and ODBC connection strings

preferredMaintenanceWindow String

The weekly time range (in UTC) during which automated cluster maintenance can occur.

publiclyAccessible Boolean

If true, the cluster can be accessed from a public network.

resourceAction String

The Redshift operation to be performed. Resource Action supports pause-cluster, resume-cluster, failover-primary-compute APIs

revisionTarget String

The identifier of the database revision. You can retrieve this value from the response to the DescribeClusterDbRevisions request.

rotateEncryptionKey Boolean

A boolean indicating if we want to rotate Encryption Keys.

snapshotCopyGrantName String

The name of the snapshot copy grant to use when snapshots of an AWS KMS-encrypted cluster are copied to the destination region.

snapshotCopyManual Boolean

Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots.

snapshotCopyRetentionPeriod Number

The number of days to retain automated snapshots in the destination region after they are copied from the source region.

Default is 7.

Constraints: Must be at least 1 and no more than 35.

tags List<Property Map>

The list of tags for the cluster parameter group.

vpcSecurityGroupIds List<String>

A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.

Supporting Types

ClusterEndpoint

Address string: The DNS address of the cluster. This property is read only.
Port string: The port that the database engine is listening on. This property is read only.

Address string: The DNS address of the cluster. This property is read only.
Port string: The port that the database engine is listening on. This property is read only.

address String: The DNS address of the cluster. This property is read only.
port String: The port that the database engine is listening on. This property is read only.

address string: The DNS address of the cluster. This property is read only.
port string: The port that the database engine is listening on. This property is read only.

address str: The DNS address of the cluster. This property is read only.
port str: The port that the database engine is listening on. This property is read only.

address String: The DNS address of the cluster. This property is read only.
port String: The port that the database engine is listening on. This property is read only.

ClusterLoggingProperties

BucketName string

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

LogDestinationType string

The log destination type. An enum with possible values of s3 and cloudwatch .

LogExports List<string>

The collection of exported log types. Possible values are connectionlog , useractivitylog , and userlog .

S3KeyPrefix string

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 ( @ ).

BucketName string

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

Constraints: