aws.rds.Cluster

RDS Cluster Resource ID

Endpoint string

DNS address of the RDS instance

MasterUserSecrets List<ClusterMasterUserSecret>

Running version of the database.

HostedZoneId string

Route53 Hosted Zone ID of the endpoint

Id string

The provider-assigned unique ID for this managed resource.

Block that specifies the master user secret. Only available when manage_master_user_password is set to true. Documented below.

ReaderEndpoint string

Read-only endpoint for the Aurora cluster, automatically load-balanced across replicas

TagsAll Dictionary<string, string>

Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated:

Please use tags instead.

Arn string

Amazon Resource Name (ARN) of cluster

RDS Cluster Resource ID

Endpoint string

DNS address of the RDS instance

MasterUserSecrets []ClusterMasterUserSecret

Running version of the database.

HostedZoneId string

Route53 Hosted Zone ID of the endpoint

Id string

The provider-assigned unique ID for this managed resource.

Block that specifies the master user secret. Only available when manage_master_user_password is set to true. Documented below.

ReaderEndpoint string

Read-only endpoint for the Aurora cluster, automatically load-balanced across replicas

TagsAll map[string]string

Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated:

Please use tags instead.

arn String

Amazon Resource Name (ARN) of cluster

RDS Cluster Resource ID

endpoint String

DNS address of the RDS instance

masterUserSecrets List<ClusterMasterUserSecret>

Running version of the database.

hostedZoneId String

Route53 Hosted Zone ID of the endpoint

id String

The provider-assigned unique ID for this managed resource.

Block that specifies the master user secret. Only available when manage_master_user_password is set to true. Documented below.

readerEndpoint String

Read-only endpoint for the Aurora cluster, automatically load-balanced across replicas

tagsAll Map<String,String>

Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated:

Please use tags instead.

arn string

Amazon Resource Name (ARN) of cluster

clusterResourceId string

RDS Cluster Resource ID

endpoint string

DNS address of the RDS instance

engineVersionActual string

Running version of the database.

hostedZoneId string

Route53 Hosted Zone ID of the endpoint

id string

The provider-assigned unique ID for this managed resource.

masterUserSecrets ClusterMasterUserSecret[]

Block that specifies the master user secret. Only available when manage_master_user_password is set to true. Documented below.

readerEndpoint string

Read-only endpoint for the Aurora cluster, automatically load-balanced across replicas

tagsAll {[key: string]: string}

Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated:

Please use tags instead.

arn str

Amazon Resource Name (ARN) of cluster

cluster_resource_id str

RDS Cluster Resource ID

endpoint str

DNS address of the RDS instance

engine_version_actual str

Running version of the database.

hosted_zone_id str

Route53 Hosted Zone ID of the endpoint

id str

The provider-assigned unique ID for this managed resource.

master_user_secrets Sequence[ClusterMasterUserSecret]

Block that specifies the master user secret. Only available when manage_master_user_password is set to true. Documented below.

reader_endpoint str

Read-only endpoint for the Aurora cluster, automatically load-balanced across replicas

tags_all Mapping[str, str]

Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated:

Please use tags instead.

arn String

Amazon Resource Name (ARN) of cluster

RDS Cluster Resource ID

endpoint String

DNS address of the RDS instance

masterUserSecrets List<Property Map>

Running version of the database.

hostedZoneId String

Route53 Hosted Zone ID of the endpoint

id String

The provider-assigned unique ID for this managed resource.

Block that specifies the master user secret. Only available when manage_master_user_password is set to true. Documented below.

readerEndpoint String

Read-only endpoint for the Aurora cluster, automatically load-balanced across replicas

tagsAll Map<String>

Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated:

Please use tags instead.

Look up Existing Cluster Resource

Get an existing Cluster resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: ClusterState, opts?: CustomResourceOptions): Cluster

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        allocated_storage: Optional[int] = None,
        allow_major_version_upgrade: Optional[bool] = None,
        apply_immediately: Optional[bool] = None,
        arn: Optional[str] = None,
        availability_zones: Optional[Sequence[str]] = None,
        backtrack_window: Optional[int] = None,
        backup_retention_period: Optional[int] = None,
        cluster_identifier: Optional[str] = None,
        cluster_identifier_prefix: Optional[str] = None,
        cluster_members: Optional[Sequence[str]] = None,
        cluster_resource_id: Optional[str] = None,
        copy_tags_to_snapshot: Optional[bool] = None,
        database_name: Optional[str] = None,
        db_cluster_instance_class: Optional[str] = None,
        db_cluster_parameter_group_name: Optional[str] = None,
        db_instance_parameter_group_name: Optional[str] = None,
        db_subnet_group_name: Optional[str] = None,
        db_system_id: Optional[str] = None,
        deletion_protection: Optional[bool] = None,
        enable_global_write_forwarding: Optional[bool] = None,
        enable_http_endpoint: Optional[bool] = None,
        enabled_cloudwatch_logs_exports: Optional[Sequence[str]] = None,
        endpoint: Optional[str] = None,
        engine: Optional[Union[str, EngineType]] = None,
        engine_mode: Optional[Union[str, EngineMode]] = None,
        engine_version: Optional[str] = None,
        engine_version_actual: Optional[str] = None,
        final_snapshot_identifier: Optional[str] = None,
        global_cluster_identifier: Optional[str] = None,
        hosted_zone_id: Optional[str] = None,
        iam_database_authentication_enabled: Optional[bool] = None,
        iam_roles: Optional[Sequence[str]] = None,
        iops: Optional[int] = None,
        kms_key_id: Optional[str] = None,
        manage_master_user_password: Optional[bool] = None,
        master_password: Optional[str] = None,
        master_user_secret_kms_key_id: Optional[str] = None,
        master_user_secrets: Optional[Sequence[ClusterMasterUserSecretArgs]] = None,
        master_username: Optional[str] = None,
        network_type: Optional[str] = None,
        port: Optional[int] = None,
        preferred_backup_window: Optional[str] = None,
        preferred_maintenance_window: Optional[str] = None,
        reader_endpoint: Optional[str] = None,
        replication_source_identifier: Optional[str] = None,
        restore_to_point_in_time: Optional[ClusterRestoreToPointInTimeArgs] = None,
        s3_import: Optional[ClusterS3ImportArgs] = None,
        scaling_configuration: Optional[ClusterScalingConfigurationArgs] = None,
        serverlessv2_scaling_configuration: Optional[ClusterServerlessv2ScalingConfigurationArgs] = None,
        skip_final_snapshot: Optional[bool] = None,
        snapshot_identifier: Optional[str] = None,
        source_region: Optional[str] = None,
        storage_encrypted: Optional[bool] = None,
        storage_type: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        vpc_security_group_ids: Optional[Sequence[str]] = None) -> Cluster

func GetCluster(ctx *Context, name string, id IDInput, state *ClusterState, opts ...ResourceOption) (*Cluster, error)

public static Cluster Get(string name, Input<string> id, ClusterState? state, CustomResourceOptions? opts = null)

public static Cluster get(String name, Output<String> id, ClusterState state, CustomResourceOptions options)

Resource lookup is not supported in YAML

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

AllocatedStorage int

(Required for Multi-AZ DB cluster) The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.

AllowMajorVersionUpgrade bool

Enable to allow major engine version upgrades when changing engine versions. Defaults to false.

ApplyImmediately bool

Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is false. See Amazon RDS Documentation for more information.

Arn string

Amazon Resource Name (ARN) of cluster

AvailabilityZones List<string>

List of EC2 Availability Zones for the DB cluster storage where DB cluster instances can be created. RDS automatically assigns 3 AZs if less than 3 AZs are configured, which will show as a difference requiring resource recreation next apply. We recommend specifying 3 AZs or using the lifecycle configuration block ignore_changes argument if necessary. A maximum of 3 AZs can be configured.

BacktrackWindow int

Target backtrack window, in seconds. Only available for aurora and aurora-mysql engines currently. To disable backtracking, set this value to 0. Defaults to 0. Must be between 0 and 259200 (72 hours)

BackupRetentionPeriod int

Days to retain backups for. Default 1

ClusterIdentifier string

The cluster identifier. If omitted, this provider will assign a random, unique identifier.

ClusterIdentifierPrefix string

Creates a unique cluster identifier beginning with the specified prefix. Conflicts with cluster_identifier.

ClusterMembers List<string>

List of RDS Instances that are a part of this cluster

RDS Cluster Resource ID

CopyTagsToSnapshot bool

Copy all Cluster tags to snapshots. Default is false.

DatabaseName string

Name for an automatically created database on cluster creation. There are different naming restrictions per database engine: RDS Naming Constraints

DbClusterInstanceClass string

(Required for Multi-AZ DB cluster) The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge. Not all DB instance classes are available in all AWS Regions, or for all database engines. For the full list of DB instance classes and availability for your engine, see DB instance class in the Amazon RDS User Guide.

DbClusterParameterGroupName string

A cluster parameter group to associate with the cluster.

DbInstanceParameterGroupName string

Instance parameter group to associate with all instances of the DB cluster. The db_instance_parameter_group_name parameter is only valid in combination with the allow_major_version_upgrade parameter.

DbSubnetGroupName string

DB subnet group to associate with this DB instance. NOTE: This must match the db_subnet_group_name specified on every aws.rds.ClusterInstance in the cluster.

DbSystemId string

For use with RDS Custom.

DeletionProtection bool

If the DB instance should have deletion protection enabled. The database can't be deleted when this value is set to true. The default is false.

EnableGlobalWriteForwarding bool

Whether cluster should forward writes to an associated global cluster. Applied to secondary clusters to enable them to forward writes to an aws.rds.GlobalCluster's primary cluster. See the Aurora Userguide documentation for more information.

EnableHttpEndpoint bool

Enable HTTP endpoint (data API). Only valid when engine_mode is set to serverless.

EnabledCloudwatchLogsExports List<string>

Set of log types to export to cloudwatch. If omitted, no logs will be exported. The following log types are supported: audit, error, general, slowquery, postgresql (PostgreSQL).

Endpoint string

DNS address of the RDS instance

Engine string | Pulumi.Aws.Rds.EngineType

Name of the database engine to be used for this DB cluster. Valid Values: aurora-mysql, aurora-postgresql, mysql, postgres. (Note that mysql and postgres are Multi-AZ RDS clusters).

EngineMode string | Pulumi.Aws.Rds.EngineMode

Database engine mode. Valid values: global (only valid for Aurora MySQL 1.21 and earlier), multimaster, parallelquery, provisioned, serverless. Defaults to: provisioned. See the RDS User Guide for limitations when using serverless.

EngineVersion string

Database engine version. Updating this argument results in an outage. See the Aurora MySQL and Aurora Postgres documentation for your configured engine to determine this value, or by running aws rds describe-db-engine-versions. For example with Aurora MySQL 2, a potential value for this argument is 5.7.mysql_aurora.2.03.2. The value can contain a partial version where supported by the API. The actual engine version used is returned in the attribute engine_version_actual, , see Attribute Reference below.

MasterUserSecrets List<ClusterMasterUserSecret>

Running version of the database.

FinalSnapshotIdentifier string

Name of your final DB snapshot when this DB cluster is deleted. If omitted, no final snapshot will be made.

GlobalClusterIdentifier string

Global cluster identifier specified on aws.rds.GlobalCluster.

HostedZoneId string

Route53 Hosted Zone ID of the endpoint

IamDatabaseAuthenticationEnabled bool

Specifies whether or not mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled. Please see AWS Documentation for availability and limitations.

IamRoles List<string>

List of ARNs for the IAM roles to associate to the RDS Cluster.

Iops int

Amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster. For information about valid Iops values, see Amazon RDS Provisioned IOPS storage to improve performance in the Amazon RDS User Guide. (This setting is required to create a Multi-AZ DB cluster). Must be a multiple between .5 and 50 of the storage amount for the DB cluster.

KmsKeyId string

ARN for the KMS encryption key. When specifying kms_key_id, storage_encrypted needs to be set to true.

ManageMasterUserPassword bool

Set to true to allow RDS to manage the master user password in Secrets Manager. Cannot be set if master_password is provided.

MasterPassword string

Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file. Please refer to the RDS Naming Constraints. Cannot be set if manage_master_user_password is set to true.

MasterUserSecretKmsKeyId string

Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN. If not specified, the default KMS key for your Amazon Web Services account is used.

Block that specifies the master user secret. Only available when manage_master_user_password is set to true. Documented below.

MasterUsername string

Username for the master DB user. Please refer to the RDS Naming Constraints. This argument does not support in-place updates and cannot be changed during a restore from snapshot.

NetworkType string

Network type of the cluster. Valid values: IPV4, DUAL.

Port int

Port on which the DB accepts connections

PreferredBackupWindow string

Daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.Time in UTC. Default: A 30-minute window selected at random from an 8-hour block of time per regionE.g., 04:00-09:00

PreferredMaintenanceWindow string

Weekly time range during which system maintenance can occur, in (UTC) e.g., wed:04:00-wed:04:30

ReaderEndpoint string

Read-only endpoint for the Aurora cluster, automatically load-balanced across replicas

ReplicationSourceIdentifier string

ARN of a source DB cluster or DB instance if this DB cluster is to be created as a Read Replica. If DB Cluster is part of a Global Cluster, use the lifecycle configuration block ignore_changes argument to prevent this provider from showing differences for this argument instead of configuring this value.

RestoreToPointInTime ClusterRestoreToPointInTime

Nested attribute for point in time restore. More details below.

S3Import ClusterS3Import

ScalingConfiguration ClusterScalingConfiguration

Nested attribute with scaling properties. Only valid when engine_mode is set to serverless. More details below.

Serverlessv2ScalingConfiguration ClusterServerlessv2ScalingConfiguration

Nested attribute with scaling properties for ServerlessV2. Only valid when engine_mode is set to provisioned. More details below.

SkipFinalSnapshot bool

Determines whether a final DB snapshot is created before the DB cluster is deleted. If true is specified, no DB snapshot is created. If false is specified, a DB snapshot is created before the DB cluster is deleted, using the value from final_snapshot_identifier. Default is false.

SnapshotIdentifier string

Specifies whether or not to create this cluster from a snapshot. You can use either the name or ARN when specifying a DB cluster snapshot, or the ARN when specifying a DB snapshot. Conflicts with global_cluster_identifier. Clusters cannot be restored from snapshot and joined to an existing global cluster in a single operation. See the AWS documentation or the Global Cluster Restored From Snapshot example for instructions on building a global cluster starting with a snapshot.

SourceRegion string

The source region for an encrypted replica DB cluster.

StorageEncrypted bool

Specifies whether the DB cluster is encrypted. The default is false for provisioned engine_mode and true for serverless engine_mode. When restoring an unencrypted snapshot_identifier, the kms_key_id argument must be provided to encrypt the restored cluster. The provider will only perform drift detection if a configuration value is provided.

StorageType string

(Required for Multi-AZ DB clusters) (Forces new for Multi-AZ DB clusters) Specifies the storage type to be associated with the DB cluster. For Aurora DB clusters, storage_type modifications can be done in-place. For Multi-AZ DB Clusters, the iops argument must also be set. Valid values are: "", aurora-iopt1 (Aurora DB Clusters); io1 (Multi-AZ DB Clusters). Default: "" (Aurora DB Clusters); io1 (Multi-AZ DB Clusters).

Tags Dictionary<string, string>

A map of tags to assign to the DB cluster. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

TagsAll Dictionary<string, string>

Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated:

Please use tags instead.

VpcSecurityGroupIds List<string>

List of VPC security groups to associate with the Cluster

AllocatedStorage int

(Required for Multi-AZ DB cluster) The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.

AllowMajorVersionUpgrade bool

Enable to allow major engine version upgrades when changing engine versions. Defaults to false.

ApplyImmediately bool

Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is false. See Amazon RDS Documentation for more information.

Arn string

Amazon Resource Name (ARN) of cluster

AvailabilityZones []string

BacktrackWindow int

BackupRetentionPeriod int

Days to retain backups for. Default 1

ClusterIdentifier string

The cluster identifier. If omitted, this provider will assign a random, unique identifier.

ClusterIdentifierPrefix string

Creates a unique cluster identifier beginning with the specified prefix. Conflicts with cluster_identifier.

ClusterMembers []string

List of RDS Instances that are a part of this cluster

RDS Cluster Resource ID

CopyTagsToSnapshot bool

Copy all Cluster tags to snapshots. Default is false.

DatabaseName string

Name for an automatically created database on cluster creation. There are different naming restrictions per database engine: RDS Naming Constraints

DbClusterInstanceClass string

DbClusterParameterGroupName string

A cluster parameter group to associate with the cluster.

DbInstanceParameterGroupName string

DbSubnetGroupName string

DB subnet group to associate with this DB instance. NOTE: This must match the db_subnet_group_name specified on every aws.rds.ClusterInstance in the cluster.

DbSystemId string

For use with RDS Custom.

DeletionProtection bool

If the DB instance should have deletion protection enabled. The database can't be deleted when this value is set to true. The default is false.

EnableGlobalWriteForwarding bool

EnableHttpEndpoint bool

Enable HTTP endpoint (data API). Only valid when engine_mode is set to serverless.

EnabledCloudwatchLogsExports []string

Set of log types to export to cloudwatch. If omitted, no logs will be exported. The following log types are supported: audit, error, general, slowquery, postgresql (PostgreSQL).

Endpoint string

DNS address of the RDS instance

Engine string | EngineType

Name of the database engine to be used for this DB cluster. Valid Values: aurora-mysql, aurora-postgresql, mysql, postgres. (Note that mysql and postgres are Multi-AZ RDS clusters).

EngineMode string | EngineMode

EngineVersion string

MasterUserSecrets []ClusterMasterUserSecretArgs

Running version of the database.

FinalSnapshotIdentifier string

Name of your final DB snapshot when this DB cluster is deleted. If omitted, no final snapshot will be made.

GlobalClusterIdentifier string

Global cluster identifier specified on aws.rds.GlobalCluster.

HostedZoneId string

Route53 Hosted Zone ID of the endpoint

IamDatabaseAuthenticationEnabled bool

Specifies whether or not mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled. Please see AWS Documentation for availability and limitations.

IamRoles []string

List of ARNs for the IAM roles to associate to the RDS Cluster.

Iops int

KmsKeyId string

ARN for the KMS encryption key. When specifying kms_key_id, storage_encrypted needs to be set to true.

ManageMasterUserPassword bool

Set to true to allow RDS to manage the master user password in Secrets Manager. Cannot be set if master_password is provided.

MasterPassword string

MasterUserSecretKmsKeyId string

Block that specifies the master user secret. Only available when manage_master_user_password is set to true. Documented below.

MasterUsername string

Username for the master DB user. Please refer to the RDS Naming Constraints. This argument does not support in-place updates and cannot be changed during a restore from snapshot.

NetworkType string

Network type of the cluster. Valid values: IPV4, DUAL.

Port int

Port on which the DB accepts connections

PreferredBackupWindow string

PreferredMaintenanceWindow string

Weekly time range during which system maintenance can occur, in (UTC) e.g., wed:04:00-wed:04:30

ReaderEndpoint string

Read-only endpoint for the Aurora cluster, automatically load-balanced across replicas

ReplicationSourceIdentifier string

RestoreToPointInTime ClusterRestoreToPointInTimeArgs

Nested attribute for point in time restore. More details below.

S3Import ClusterS3ImportArgs

ScalingConfiguration ClusterScalingConfigurationArgs

Nested attribute with scaling properties. Only valid when engine_mode is set to serverless. More details below.

Serverlessv2ScalingConfiguration ClusterServerlessv2ScalingConfigurationArgs

Nested attribute with scaling properties for ServerlessV2. Only valid when engine_mode is set to provisioned. More details below.

SkipFinalSnapshot bool

SnapshotIdentifier string

SourceRegion string

The source region for an encrypted replica DB cluster.

StorageEncrypted bool

StorageType string

Tags map[string]string

A map of tags to assign to the DB cluster. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

TagsAll map[string]string

Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated:

Please use tags instead.

VpcSecurityGroupIds []string

List of VPC security groups to associate with the Cluster

allocatedStorage Integer

(Required for Multi-AZ DB cluster) The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.

allowMajorVersionUpgrade Boolean

Enable to allow major engine version upgrades when changing engine versions. Defaults to false.

applyImmediately Boolean

Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is false. See Amazon RDS Documentation for more information.

arn String

Amazon Resource Name (ARN) of cluster

availabilityZones List<String>

backtrackWindow Integer

backupRetentionPeriod Integer

Days to retain backups for. Default 1

clusterIdentifier String

The cluster identifier. If omitted, this provider will assign a random, unique identifier.

clusterIdentifierPrefix String

Creates a unique cluster identifier beginning with the specified prefix. Conflicts with cluster_identifier.

clusterMembers List<String>

List of RDS Instances that are a part of this cluster

RDS Cluster Resource ID

copyTagsToSnapshot Boolean

Copy all Cluster tags to snapshots. Default is false.

databaseName String

Name for an automatically created database on cluster creation. There are different naming restrictions per database engine: RDS Naming Constraints

dbClusterInstanceClass String

dbClusterParameterGroupName String

A cluster parameter group to associate with the cluster.

dbInstanceParameterGroupName String

dbSubnetGroupName String

DB subnet group to associate with this DB instance. NOTE: This must match the db_subnet_group_name specified on every aws.rds.ClusterInstance in the cluster.

dbSystemId String

For use with RDS Custom.

deletionProtection Boolean

If the DB instance should have deletion protection enabled. The database can't be deleted when this value is set to true. The default is false.

enableGlobalWriteForwarding Boolean

enableHttpEndpoint Boolean

Enable HTTP endpoint (data API). Only valid when engine_mode is set to serverless.

enabledCloudwatchLogsExports List<String>

Set of log types to export to cloudwatch. If omitted, no logs will be exported. The following log types are supported: audit, error, general, slowquery, postgresql (PostgreSQL).

endpoint String

DNS address of the RDS instance

engine String | EngineType

Name of the database engine to be used for this DB cluster. Valid Values: aurora-mysql, aurora-postgresql, mysql, postgres. (Note that mysql and postgres are Multi-AZ RDS clusters).

engineMode String | EngineMode

engineVersion String

masterUserSecrets List<ClusterMasterUserSecret>

Running version of the database.

finalSnapshotIdentifier String

Name of your final DB snapshot when this DB cluster is deleted. If omitted, no final snapshot will be made.

globalClusterIdentifier String

Global cluster identifier specified on aws.rds.GlobalCluster.

hostedZoneId String

Route53 Hosted Zone ID of the endpoint

iamDatabaseAuthenticationEnabled Boolean

Specifies whether or not mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled. Please see AWS Documentation for availability and limitations.

iamRoles List<String>

List of ARNs for the IAM roles to associate to the RDS Cluster.

iops Integer

kmsKeyId String

ARN for the KMS encryption key. When specifying kms_key_id, storage_encrypted needs to be set to true.

manageMasterUserPassword Boolean

Set to true to allow RDS to manage the master user password in Secrets Manager. Cannot be set if master_password is provided.

masterPassword String

masterUserSecretKmsKeyId String

Block that specifies the master user secret. Only available when manage_master_user_password is set to true. Documented below.

masterUsername String

Username for the master DB user. Please refer to the RDS Naming Constraints. This argument does not support in-place updates and cannot be changed during a restore from snapshot.

networkType String

Network type of the cluster. Valid values: IPV4, DUAL.

port Integer

Port on which the DB accepts connections

preferredBackupWindow String

preferredMaintenanceWindow String

Weekly time range during which system maintenance can occur, in (UTC) e.g., wed:04:00-wed:04:30

readerEndpoint String

Read-only endpoint for the Aurora cluster, automatically load-balanced across replicas

replicationSourceIdentifier String

restoreToPointInTime ClusterRestoreToPointInTime

Nested attribute for point in time restore. More details below.

s3Import ClusterS3Import

scalingConfiguration ClusterScalingConfiguration

Nested attribute with scaling properties. Only valid when engine_mode is set to serverless. More details below.

serverlessv2ScalingConfiguration ClusterServerlessv2ScalingConfiguration

Nested attribute with scaling properties for ServerlessV2. Only valid when engine_mode is set to provisioned. More details below.

skipFinalSnapshot Boolean

snapshotIdentifier String

sourceRegion String

The source region for an encrypted replica DB cluster.

storageEncrypted Boolean

storageType String

tags Map<String,String>

A map of tags to assign to the DB cluster. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

tagsAll Map<String,String>

Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated:

Please use tags instead.

vpcSecurityGroupIds List<String>

List of VPC security groups to associate with the Cluster

allocatedStorage number

(Required for Multi-AZ DB cluster) The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.

allowMajorVersionUpgrade boolean

Enable to allow major engine version upgrades when changing engine versions. Defaults to false.

applyImmediately boolean

Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is false. See Amazon RDS Documentation for more information.

arn string

Amazon Resource Name (ARN) of cluster

availabilityZones string[]

backtrackWindow number

backupRetentionPeriod number

Days to retain backups for. Default 1

clusterIdentifier string

The cluster identifier. If omitted, this provider will assign a random, unique identifier.

clusterIdentifierPrefix string

Creates a unique cluster identifier beginning with the specified prefix. Conflicts with cluster_identifier.

clusterMembers string[]

List of RDS Instances that are a part of this cluster

clusterResourceId string

RDS Cluster Resource ID

copyTagsToSnapshot boolean

Copy all Cluster tags to snapshots. Default is false.

databaseName string

Name for an automatically created database on cluster creation. There are different naming restrictions per database engine: RDS Naming Constraints

dbClusterInstanceClass string

dbClusterParameterGroupName string

A cluster parameter group to associate with the cluster.

dbInstanceParameterGroupName string

dbSubnetGroupName string

DB subnet group to associate with this DB instance. NOTE: This must match the db_subnet_group_name specified on every aws.rds.ClusterInstance in the cluster.

dbSystemId string

For use with RDS Custom.

deletionProtection boolean

If the DB instance should have deletion protection enabled. The database can't be deleted when this value is set to true. The default is false.

enableGlobalWriteForwarding boolean

enableHttpEndpoint boolean

Enable HTTP endpoint (data API). Only valid when engine_mode is set to serverless.

enabledCloudwatchLogsExports string[]

Set of log types to export to cloudwatch. If omitted, no logs will be exported. The following log types are supported: audit, error, general, slowquery, postgresql (PostgreSQL).

endpoint string

DNS address of the RDS instance

engine string | EngineType

Name of the database engine to be used for this DB cluster. Valid Values: aurora-mysql, aurora-postgresql, mysql, postgres. (Note that mysql and postgres are Multi-AZ RDS clusters).

engineMode string | EngineMode

engineVersion string

engineVersionActual string

Running version of the database.

finalSnapshotIdentifier string

Name of your final DB snapshot when this DB cluster is deleted. If omitted, no final snapshot will be made.

globalClusterIdentifier string

Global cluster identifier specified on aws.rds.GlobalCluster.

hostedZoneId string

Route53 Hosted Zone ID of the endpoint

iamDatabaseAuthenticationEnabled boolean

Specifies whether or not mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled. Please see AWS Documentation for availability and limitations.

iamRoles string[]

List of ARNs for the IAM roles to associate to the RDS Cluster.

iops number

kmsKeyId string

ARN for the KMS encryption key. When specifying kms_key_id, storage_encrypted needs to be set to true.

manageMasterUserPassword boolean

Set to true to allow RDS to manage the master user password in Secrets Manager. Cannot be set if master_password is provided.

masterPassword string

masterUserSecretKmsKeyId string

masterUserSecrets ClusterMasterUserSecret[]

Block that specifies the master user secret. Only available when manage_master_user_password is set to true. Documented below.

masterUsername string

Username for the master DB user. Please refer to the RDS Naming Constraints. This argument does not support in-place updates and cannot be changed during a restore from snapshot.

networkType string

Network type of the cluster. Valid values: IPV4, DUAL.

port number

Port on which the DB accepts connections

preferredBackupWindow string

preferredMaintenanceWindow string

Weekly time range during which system maintenance can occur, in (UTC) e.g., wed:04:00-wed:04:30

readerEndpoint string

Read-only endpoint for the Aurora cluster, automatically load-balanced across replicas

replicationSourceIdentifier string

restoreToPointInTime ClusterRestoreToPointInTime

Nested attribute for point in time restore. More details below.

s3Import ClusterS3Import

scalingConfiguration ClusterScalingConfiguration

Nested attribute with scaling properties. Only valid when engine_mode is set to serverless. More details below.

serverlessv2ScalingConfiguration ClusterServerlessv2ScalingConfiguration

Nested attribute with scaling properties for ServerlessV2. Only valid when engine_mode is set to provisioned. More details below.

skipFinalSnapshot boolean

snapshotIdentifier string

sourceRegion string

The source region for an encrypted replica DB cluster.

storageEncrypted boolean

storageType string

tags {[key: string]: string}

A map of tags to assign to the DB cluster. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

tagsAll {[key: string]: string}

Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated:

Please use tags instead.

vpcSecurityGroupIds string[]

List of VPC security groups to associate with the Cluster

allocated_storage int

(Required for Multi-AZ DB cluster) The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.

allow_major_version_upgrade bool

Enable to allow major engine version upgrades when changing engine versions. Defaults to false.

apply_immediately bool

Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is false. See Amazon RDS Documentation for more information.

arn str

Amazon Resource Name (ARN) of cluster

availability_zones Sequence[str]

backtrack_window int

backup_retention_period int

Days to retain backups for. Default 1

cluster_identifier str

The cluster identifier. If omitted, this provider will assign a random, unique identifier.

cluster_identifier_prefix str

Creates a unique cluster identifier beginning with the specified prefix. Conflicts with cluster_identifier.

cluster_members Sequence[str]

List of RDS Instances that are a part of this cluster

cluster_resource_id str

RDS Cluster Resource ID

copy_tags_to_snapshot bool

Copy all Cluster tags to snapshots. Default is false.

database_name str

Name for an automatically created database on cluster creation. There are different naming restrictions per database engine: RDS Naming Constraints

db_cluster_instance_class str

db_cluster_parameter_group_name str

A cluster parameter group to associate with the cluster.

db_instance_parameter_group_name str

db_subnet_group_name str

DB subnet group to associate with this DB instance. NOTE: This must match the db_subnet_group_name specified on every aws.rds.ClusterInstance in the cluster.

db_system_id str

For use with RDS Custom.

deletion_protection bool

If the DB instance should have deletion protection enabled. The database can't be deleted when this value is set to true. The default is false.

enable_global_write_forwarding bool

enable_http_endpoint bool

Enable HTTP endpoint (data API). Only valid when engine_mode is set to serverless.

enabled_cloudwatch_logs_exports Sequence[str]

Set of log types to export to cloudwatch. If omitted, no logs will be exported. The following log types are supported: audit, error, general, slowquery, postgresql (PostgreSQL).

endpoint str

DNS address of the RDS instance

engine str | EngineType

Name of the database engine to be used for this DB cluster. Valid Values: aurora-mysql, aurora-postgresql, mysql, postgres. (Note that mysql and postgres are Multi-AZ RDS clusters).

engine_mode str | EngineMode

engine_version str

engine_version_actual str

Running version of the database.

final_snapshot_identifier str

Name of your final DB snapshot when this DB cluster is deleted. If omitted, no final snapshot will be made.

global_cluster_identifier str

Global cluster identifier specified on aws.rds.GlobalCluster.

hosted_zone_id str

Route53 Hosted Zone ID of the endpoint

iam_database_authentication_enabled bool

Specifies whether or not mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled. Please see AWS Documentation for availability and limitations.

iam_roles Sequence[str]

List of ARNs for the IAM roles to associate to the RDS Cluster.

iops int

kms_key_id str

ARN for the KMS encryption key. When specifying kms_key_id, storage_encrypted needs to be set to true.

manage_master_user_password bool

Set to true to allow RDS to manage the master user password in Secrets Manager. Cannot be set if master_password is provided.

master_password str

master_user_secret_kms_key_id str

master_user_secrets Sequence[ClusterMasterUserSecretArgs]

Block that specifies the master user secret. Only available when manage_master_user_password is set to true. Documented below.

master_username str

Username for the master DB user. Please refer to the RDS Naming Constraints. This argument does not support in-place updates and cannot be changed during a restore from snapshot.

network_type str

Network type of the cluster. Valid values: IPV4, DUAL.

port int

Port on which the DB accepts connections

preferred_backup_window str

preferred_maintenance_window str

Weekly time range during which system maintenance can occur, in (UTC) e.g., wed:04:00-wed:04:30

reader_endpoint str

Read-only endpoint for the Aurora cluster, automatically load-balanced across replicas

replication_source_identifier str

restore_to_point_in_time ClusterRestoreToPointInTimeArgs

Nested attribute for point in time restore. More details below.

s3_import ClusterS3ImportArgs

scaling_configuration ClusterScalingConfigurationArgs

Nested attribute with scaling properties. Only valid when engine_mode is set to serverless. More details below.

serverlessv2_scaling_configuration ClusterServerlessv2ScalingConfigurationArgs

Nested attribute with scaling properties for ServerlessV2. Only valid when engine_mode is set to provisioned. More details below.

skip_final_snapshot bool

snapshot_identifier str

source_region str

The source region for an encrypted replica DB cluster.

storage_encrypted bool

storage_type str

tags Mapping[str, str]

A map of tags to assign to the DB cluster. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

tags_all Mapping[str, str]

Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated:

Please use tags instead.

vpc_security_group_ids Sequence[str]

List of VPC security groups to associate with the Cluster

allocatedStorage Number

(Required for Multi-AZ DB cluster) The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.

allowMajorVersionUpgrade Boolean

Enable to allow major engine version upgrades when changing engine versions. Defaults to false.

applyImmediately Boolean

Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is false. See Amazon RDS Documentation for more information.

arn String

Amazon Resource Name (ARN) of cluster

availabilityZones List<String>

backtrackWindow Number

backupRetentionPeriod Number

Days to retain backups for. Default 1

clusterIdentifier String

The cluster identifier. If omitted, this provider will assign a random, unique identifier.

clusterIdentifierPrefix String

Creates a unique cluster identifier beginning with the specified prefix. Conflicts with cluster_identifier.

clusterMembers List<String>

List of RDS Instances that are a part of this cluster

RDS Cluster Resource ID

copyTagsToSnapshot Boolean

Copy all Cluster tags to snapshots. Default is false.

databaseName String

Name for an automatically created database on cluster creation. There are different naming restrictions per database engine: RDS Naming Constraints

dbClusterInstanceClass String

dbClusterParameterGroupName String

A cluster parameter group to associate with the cluster.

dbInstanceParameterGroupName String

dbSubnetGroupName String

DB subnet group to associate with this DB instance. NOTE: This must match the db_subnet_group_name specified on every aws.rds.ClusterInstance in the cluster.

dbSystemId String

For use with RDS Custom.

deletionProtection Boolean

If the DB instance should have deletion protection enabled. The database can't be deleted when this value is set to true. The default is false.

enableGlobalWriteForwarding Boolean

enableHttpEndpoint Boolean

Enable HTTP endpoint (data API). Only valid when engine_mode is set to serverless.

enabledCloudwatchLogsExports List<String>

Set of log types to export to cloudwatch. If omitted, no logs will be exported. The following log types are supported: audit, error, general, slowquery, postgresql (PostgreSQL).

endpoint String

DNS address of the RDS instance

engine String | "aurora" | "aurora-mysql" | "aurora-postgresql"

Name of the database engine to be used for this DB cluster. Valid Values: aurora-mysql, aurora-postgresql, mysql, postgres. (Note that mysql and postgres are Multi-AZ RDS clusters).

engineMode String | "provisioned" | "serverless" | "parallelquery" | "global"

engineVersion String