AWS Native v0.63.0, May 25 23

aws-native.rds.getDBCluster

Explore with Pulumi AI

The AWS::RDS::DBCluster resource creates an Amazon Aurora DB cluster.

Using getDBCluster

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 getDBCluster(args: GetDBClusterArgs, opts?: InvokeOptions): Promise<GetDBClusterResult>
function getDBClusterOutput(args: GetDBClusterOutputArgs, opts?: InvokeOptions): Output<GetDBClusterResult>

def get_db_cluster(d_b_cluster_identifier: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetDBClusterResult
def get_db_cluster_output(d_b_cluster_identifier: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetDBClusterResult]

func LookupDBCluster(ctx *Context, args *LookupDBClusterArgs, opts ...InvokeOption) (*LookupDBClusterResult, error)
func LookupDBClusterOutput(ctx *Context, args *LookupDBClusterOutputArgs, opts ...InvokeOption) LookupDBClusterResultOutput

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

public static class GetDBCluster 
{
    public static Task<GetDBClusterResult> InvokeAsync(GetDBClusterArgs args, InvokeOptions? opts = null)
    public static Output<GetDBClusterResult> Invoke(GetDBClusterInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetDBClusterResult> getDBCluster(GetDBClusterArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: aws-native:rds:getDBCluster
  arguments:
    # arguments dictionary

The following arguments are supported:

DBClusterIdentifier string: The DB cluster identifier. This parameter is stored as a lowercase string.

DBClusterIdentifier string: The DB cluster identifier. This parameter is stored as a lowercase string.

dBClusterIdentifier String: The DB cluster identifier. This parameter is stored as a lowercase string.

dBClusterIdentifier string: The DB cluster identifier. This parameter is stored as a lowercase string.

d_b_cluster_identifier str: The DB cluster identifier. This parameter is stored as a lowercase string.

dBClusterIdentifier String: The DB cluster identifier. This parameter is stored as a lowercase string.

getDBCluster Result

The following output properties are available:

AllocatedStorage int

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

AssociatedRoles List<Pulumi.AwsNative.RDS.Outputs.DBClusterRole>

Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf.

AutoMinorVersionUpgrade bool

A value that indicates whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. By default, minor engine upgrades are applied automatically.

BacktrackWindow int

The target backtrack window, in seconds. To disable backtracking, set this value to 0.

BackupRetentionPeriod int

The number of days for which automated backups are retained.

CopyTagsToSnapshot bool

A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.

DBClusterArn string

The Amazon Resource Name (ARN) for the DB cluster.

DBClusterInstanceClass string

The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge.

DBClusterParameterGroupName string

The name of the DB cluster parameter group to associate with this DB cluster.

DBClusterResourceId string

The AWS Region-unique, immutable identifier for the DB cluster.

DeletionProtection bool

A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.

Domain string

The Active Directory directory ID to create the DB cluster in.

DomainIAMRoleName string

Specify the name of the IAM role to be used when making API calls to the Directory Service.

EnableCloudwatchLogsExports List<string>

The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

EnableHttpEndpoint bool

A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster. By default, the HTTP endpoint is disabled.

EnableIAMDatabaseAuthentication bool

A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.

Endpoint Pulumi.AwsNative.RDS.Outputs.DBClusterEndpoint

Engine string

The name of the database engine to be used for this DB cluster. Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible Aurora), and aurora-postgresql

EngineVersion string

The version number of the database engine to use.

GlobalClusterIdentifier string

If you are configuring an Aurora global database cluster and want your Aurora DB cluster to be a secondary member in the global database cluster, specify the global cluster ID of the global database cluster. To define the primary database cluster of the global cluster, use the AWS::RDS::GlobalCluster resource.

If you aren't configuring a global database cluster, don't specify this property.

Iops int

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.

ManageMasterUserPassword bool

A value that indicates whether to manage the master user password with AWS Secrets Manager.

MasterUserSecret Pulumi.AwsNative.RDS.Outputs.DBClusterMasterUserSecret

Contains the secret managed by RDS in AWS Secrets Manager for the master user password.

MasterUsername string

The name of the master user for the DB cluster. You must specify MasterUsername, unless you specify SnapshotIdentifier. In that case, don't specify MasterUsername.

MonitoringInterval int

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off collecting Enhanced Monitoring metrics, specify 0. The default is 0.

MonitoringRoleArn string

The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

NetworkType string

The network type of the DB cluster.

PerformanceInsightsEnabled bool

A value that indicates whether to turn on Performance Insights for the DB cluster.

PerformanceInsightsKmsKeyId string

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

PerformanceInsightsRetentionPeriod int

The amount of time, in days, to retain Performance Insights data.

Port int

The port number on which the instances in the DB cluster accept connections. Default: 3306 if engine is set as aurora or 5432 if set to aurora-postgresql.

PreferredBackupWindow string

The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter. The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.

PreferredMaintenanceWindow string

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.

ReadEndpoint Pulumi.AwsNative.RDS.Outputs.DBClusterReadEndpoint

ReplicationSourceIdentifier string

The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a Read Replica.

ScalingConfiguration Pulumi.AwsNative.RDS.Outputs.DBClusterScalingConfiguration

The ScalingConfiguration property type specifies the scaling configuration of an Aurora Serverless DB cluster.

ServerlessV2ScalingConfiguration Pulumi.AwsNative.RDS.Outputs.DBClusterServerlessV2ScalingConfiguration

Contains the scaling configuration of an Aurora Serverless v2 DB cluster.

StorageType string

Specifies the storage type to be associated with the DB cluster.

Tags List<Pulumi.AwsNative.RDS.Outputs.DBClusterTag>

An array of key-value pairs to apply to this resource.

VpcSecurityGroupIds List<string>

A list of EC2 VPC security groups to associate with this DB cluster.

AllocatedStorage int

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

AssociatedRoles []DBClusterRole

AutoMinorVersionUpgrade bool

A value that indicates whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. By default, minor engine upgrades are applied automatically.

BacktrackWindow int

The target backtrack window, in seconds. To disable backtracking, set this value to 0.

BackupRetentionPeriod int

The number of days for which automated backups are retained.

CopyTagsToSnapshot bool

A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.

DBClusterArn string

The Amazon Resource Name (ARN) for the DB cluster.

DBClusterInstanceClass string

The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge.

DBClusterParameterGroupName string

The name of the DB cluster parameter group to associate with this DB cluster.

DBClusterResourceId string

The AWS Region-unique, immutable identifier for the DB cluster.

DeletionProtection bool

A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.

Domain string

The Active Directory directory ID to create the DB cluster in.

DomainIAMRoleName string

Specify the name of the IAM role to be used when making API calls to the Directory Service.

EnableCloudwatchLogsExports []string

EnableHttpEndpoint bool

A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster. By default, the HTTP endpoint is disabled.

EnableIAMDatabaseAuthentication bool

A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.

Endpoint DBClusterEndpoint

Engine string

The name of the database engine to be used for this DB cluster. Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible Aurora), and aurora-postgresql

EngineVersion string

The version number of the database engine to use.

GlobalClusterIdentifier string

If you aren't configuring a global database cluster, don't specify this property.

Iops int

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.

ManageMasterUserPassword bool

A value that indicates whether to manage the master user password with AWS Secrets Manager.

MasterUserSecret DBClusterMasterUserSecret

Contains the secret managed by RDS in AWS Secrets Manager for the master user password.

MasterUsername string

The name of the master user for the DB cluster. You must specify MasterUsername, unless you specify SnapshotIdentifier. In that case, don't specify MasterUsername.

MonitoringInterval int

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off collecting Enhanced Monitoring metrics, specify 0. The default is 0.

MonitoringRoleArn string

The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

NetworkType string

The network type of the DB cluster.

PerformanceInsightsEnabled bool

A value that indicates whether to turn on Performance Insights for the DB cluster.

PerformanceInsightsKmsKeyId string

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

PerformanceInsightsRetentionPeriod int

The amount of time, in days, to retain Performance Insights data.

Port int

The port number on which the instances in the DB cluster accept connections. Default: 3306 if engine is set as aurora or 5432 if set to aurora-postgresql.

PreferredBackupWindow string

PreferredMaintenanceWindow string

ReadEndpoint DBClusterReadEndpoint

ReplicationSourceIdentifier string

The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a Read Replica.

ScalingConfiguration DBClusterScalingConfiguration

The ScalingConfiguration property type specifies the scaling configuration of an Aurora Serverless DB cluster.

ServerlessV2ScalingConfiguration DBClusterServerlessV2ScalingConfiguration

Contains the scaling configuration of an Aurora Serverless v2 DB cluster.

StorageType string

Specifies the storage type to be associated with the DB cluster.

Tags []DBClusterTag

An array of key-value pairs to apply to this resource.

VpcSecurityGroupIds []string

A list of EC2 VPC security groups to associate with this DB cluster.

allocatedStorage Integer

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

associatedRoles List<DBClusterRole>

autoMinorVersionUpgrade Boolean

A value that indicates whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. By default, minor engine upgrades are applied automatically.

backtrackWindow Integer

The target backtrack window, in seconds. To disable backtracking, set this value to 0.

backupRetentionPeriod Integer

The number of days for which automated backups are retained.

copyTagsToSnapshot Boolean

A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.

dBClusterArn String

The Amazon Resource Name (ARN) for the DB cluster.

dBClusterInstanceClass String

The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge.

dBClusterParameterGroupName String

The name of the DB cluster parameter group to associate with this DB cluster.

dBClusterResourceId String

The AWS Region-unique, immutable identifier for the DB cluster.

deletionProtection Boolean

A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.

domain String

The Active Directory directory ID to create the DB cluster in.

domainIAMRoleName String

Specify the name of the IAM role to be used when making API calls to the Directory Service.

enableCloudwatchLogsExports List<String>

enableHttpEndpoint Boolean

A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster. By default, the HTTP endpoint is disabled.

enableIAMDatabaseAuthentication Boolean

A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.

endpoint DBClusterEndpoint

engine String

The name of the database engine to be used for this DB cluster. Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible Aurora), and aurora-postgresql

engineVersion String

The version number of the database engine to use.

globalClusterIdentifier String

If you aren't configuring a global database cluster, don't specify this property.

iops Integer

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.

manageMasterUserPassword Boolean

A value that indicates whether to manage the master user password with AWS Secrets Manager.

masterUserSecret DBClusterMasterUserSecret

Contains the secret managed by RDS in AWS Secrets Manager for the master user password.

masterUsername String

The name of the master user for the DB cluster. You must specify MasterUsername, unless you specify SnapshotIdentifier. In that case, don't specify MasterUsername.

monitoringInterval Integer

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off collecting Enhanced Monitoring metrics, specify 0. The default is 0.

monitoringRoleArn String

The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

networkType String

The network type of the DB cluster.

performanceInsightsEnabled Boolean

A value that indicates whether to turn on Performance Insights for the DB cluster.

performanceInsightsKmsKeyId String

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

performanceInsightsRetentionPeriod Integer

The amount of time, in days, to retain Performance Insights data.

port Integer

The port number on which the instances in the DB cluster accept connections. Default: 3306 if engine is set as aurora or 5432 if set to aurora-postgresql.

preferredBackupWindow String

preferredMaintenanceWindow String

readEndpoint DBClusterReadEndpoint

replicationSourceIdentifier String

The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a Read Replica.

scalingConfiguration DBClusterScalingConfiguration

The ScalingConfiguration property type specifies the scaling configuration of an Aurora Serverless DB cluster.

serverlessV2ScalingConfiguration DBClusterServerlessV2ScalingConfiguration

Contains the scaling configuration of an Aurora Serverless v2 DB cluster.

storageType String

Specifies the storage type to be associated with the DB cluster.

tags List<DBClusterTag>

An array of key-value pairs to apply to this resource.

vpcSecurityGroupIds List<String>

A list of EC2 VPC security groups to associate with this DB cluster.

allocatedStorage number

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

associatedRoles DBClusterRole[]

autoMinorVersionUpgrade boolean

A value that indicates whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. By default, minor engine upgrades are applied automatically.

backtrackWindow number

The target backtrack window, in seconds. To disable backtracking, set this value to 0.

backupRetentionPeriod number

The number of days for which automated backups are retained.

copyTagsToSnapshot boolean

A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.

dBClusterArn string

The Amazon Resource Name (ARN) for the DB cluster.

dBClusterInstanceClass string

The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge.

dBClusterParameterGroupName string

The name of the DB cluster parameter group to associate with this DB cluster.

dBClusterResourceId string

The AWS Region-unique, immutable identifier for the DB cluster.

deletionProtection boolean

A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.

domain string

The Active Directory directory ID to create the DB cluster in.

domainIAMRoleName string

Specify the name of the IAM role to be used when making API calls to the Directory Service.

enableCloudwatchLogsExports string[]

enableHttpEndpoint boolean

A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster. By default, the HTTP endpoint is disabled.

enableIAMDatabaseAuthentication boolean

A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.

endpoint DBClusterEndpoint

engine string

The name of the database engine to be used for this DB cluster. Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible Aurora), and aurora-postgresql

engineVersion string

The version number of the database engine to use.

globalClusterIdentifier string

If you aren't configuring a global database cluster, don't specify this property.

iops number

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.

manageMasterUserPassword boolean

A value that indicates whether to manage the master user password with AWS Secrets Manager.

masterUserSecret DBClusterMasterUserSecret

Contains the secret managed by RDS in AWS Secrets Manager for the master user password.

masterUsername string

The name of the master user for the DB cluster. You must specify MasterUsername, unless you specify SnapshotIdentifier. In that case, don't specify MasterUsername.

monitoringInterval number

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off collecting Enhanced Monitoring metrics, specify 0. The default is 0.

monitoringRoleArn string

The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

networkType string

The network type of the DB cluster.

performanceInsightsEnabled boolean

A value that indicates whether to turn on Performance Insights for the DB cluster.

performanceInsightsKmsKeyId string

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

performanceInsightsRetentionPeriod number

The amount of time, in days, to retain Performance Insights data.

port number

The port number on which the instances in the DB cluster accept connections. Default: 3306 if engine is set as aurora or 5432 if set to aurora-postgresql.

preferredBackupWindow string

preferredMaintenanceWindow string

readEndpoint DBClusterReadEndpoint

replicationSourceIdentifier string

The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a Read Replica.

scalingConfiguration DBClusterScalingConfiguration

The ScalingConfiguration property type specifies the scaling configuration of an Aurora Serverless DB cluster.

serverlessV2ScalingConfiguration DBClusterServerlessV2ScalingConfiguration

Contains the scaling configuration of an Aurora Serverless v2 DB cluster.

storageType string

Specifies the storage type to be associated with the DB cluster.

tags DBClusterTag[]

An array of key-value pairs to apply to this resource.

vpcSecurityGroupIds string[]

A list of EC2 VPC security groups to associate with this DB cluster.

allocated_storage int

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

associated_roles Sequence[DBClusterRole]

auto_minor_version_upgrade bool

A value that indicates whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. By default, minor engine upgrades are applied automatically.

backtrack_window int

The target backtrack window, in seconds. To disable backtracking, set this value to 0.

backup_retention_period int

The number of days for which automated backups are retained.

copy_tags_to_snapshot bool

A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.

d_b_cluster_arn str

The Amazon Resource Name (ARN) for the DB cluster.

d_b_cluster_instance_class str

The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge.

d_b_cluster_parameter_group_name str

The name of the DB cluster parameter group to associate with this DB cluster.

d_b_cluster_resource_id str

The AWS Region-unique, immutable identifier for the DB cluster.

deletion_protection bool

A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.

domain str

The Active Directory directory ID to create the DB cluster in.

domain_iam_role_name str

Specify the name of the IAM role to be used when making API calls to the Directory Service.

enable_cloudwatch_logs_exports Sequence[str]

enable_http_endpoint bool

A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster. By default, the HTTP endpoint is disabled.

enable_iam_database_authentication bool

A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.

endpoint DBClusterEndpoint

engine str

The name of the database engine to be used for this DB cluster. Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible Aurora), and aurora-postgresql

engine_version str

The version number of the database engine to use.

global_cluster_identifier str

If you aren't configuring a global database cluster, don't specify this property.

iops int

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.

manage_master_user_password bool

A value that indicates whether to manage the master user password with AWS Secrets Manager.

master_user_secret DBClusterMasterUserSecret

Contains the secret managed by RDS in AWS Secrets Manager for the master user password.

master_username str

The name of the master user for the DB cluster. You must specify MasterUsername, unless you specify SnapshotIdentifier. In that case, don't specify MasterUsername.

monitoring_interval int

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off collecting Enhanced Monitoring metrics, specify 0. The default is 0.

monitoring_role_arn str

The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

network_type str

The network type of the DB cluster.

performance_insights_enabled bool

A value that indicates whether to turn on Performance Insights for the DB cluster.

performance_insights_kms_key_id str

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

performance_insights_retention_period int

The amount of time, in days, to retain Performance Insights data.

port int

The port number on which the instances in the DB cluster accept connections. Default: 3306 if engine is set as aurora or 5432 if set to aurora-postgresql.

preferred_backup_window str

preferred_maintenance_window str

read_endpoint DBClusterReadEndpoint

replication_source_identifier str

The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a Read Replica.

scaling_configuration DBClusterScalingConfiguration

The ScalingConfiguration property type specifies the scaling configuration of an Aurora Serverless DB cluster.

serverless_v2_scaling_configuration DBClusterServerlessV2ScalingConfiguration

Contains the scaling configuration of an Aurora Serverless v2 DB cluster.

storage_type str

Specifies the storage type to be associated with the DB cluster.

tags Sequence[DBClusterTag]

An array of key-value pairs to apply to this resource.

vpc_security_group_ids Sequence[str]

A list of EC2 VPC security groups to associate with this DB cluster.

allocatedStorage Number

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

associatedRoles List<Property Map>

autoMinorVersionUpgrade Boolean

A value that indicates whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. By default, minor engine upgrades are applied automatically.

backtrackWindow Number

The target backtrack window, in seconds. To disable backtracking, set this value to 0.

backupRetentionPeriod Number

The number of days for which automated backups are retained.

copyTagsToSnapshot Boolean

A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.

dBClusterArn String

The Amazon Resource Name (ARN) for the DB cluster.

dBClusterInstanceClass String

The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge.

dBClusterParameterGroupName String

The name of the DB cluster parameter group to associate with this DB cluster.

dBClusterResourceId String

The AWS Region-unique, immutable identifier for the DB cluster.

deletionProtection Boolean

A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.

domain String

The Active Directory directory ID to create the DB cluster in.

domainIAMRoleName String

Specify the name of the IAM role to be used when making API calls to the Directory Service.

enableCloudwatchLogsExports List<String>

enableHttpEndpoint Boolean

A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster. By default, the HTTP endpoint is disabled.

enableIAMDatabaseAuthentication Boolean

A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.

endpoint Property Map

engine String

The name of the database engine to be used for this DB cluster. Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible Aurora), and aurora-postgresql

engineVersion String

The version number of the database engine to use.

globalClusterIdentifier String

If you aren't configuring a global database cluster, don't specify this property.

iops Number

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.

manageMasterUserPassword Boolean

A value that indicates whether to manage the master user password with AWS Secrets Manager.

masterUserSecret Property Map

Contains the secret managed by RDS in AWS Secrets Manager for the master user password.

masterUsername String

The name of the master user for the DB cluster. You must specify MasterUsername, unless you specify SnapshotIdentifier. In that case, don't specify MasterUsername.

monitoringInterval Number

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off collecting Enhanced Monitoring metrics, specify 0. The default is 0.

monitoringRoleArn String

The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

networkType String

The network type of the DB cluster.

performanceInsightsEnabled Boolean

A value that indicates whether to turn on Performance Insights for the DB cluster.

performanceInsightsKmsKeyId String

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

performanceInsightsRetentionPeriod Number

The amount of time, in days, to retain Performance Insights data.

port Number

The port number on which the instances in the DB cluster accept connections. Default: 3306 if engine is set as aurora or 5432 if set to aurora-postgresql.

preferredBackupWindow String

preferredMaintenanceWindow String

readEndpoint Property Map

replicationSourceIdentifier String

The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a Read Replica.

scalingConfiguration Property Map

The ScalingConfiguration property type specifies the scaling configuration of an Aurora Serverless DB cluster.

serverlessV2ScalingConfiguration Property Map

Contains the scaling configuration of an Aurora Serverless v2 DB cluster.

storageType String

Specifies the storage type to be associated with the DB cluster.

tags List<Property Map>

An array of key-value pairs to apply to this resource.

vpcSecurityGroupIds List<String>

A list of EC2 VPC security groups to associate with this DB cluster.

Supporting Types

DBClusterEndpoint

Address string: The connection endpoint for the DB cluster.
Port string: The port number that will accept connections on this DB cluster.

Address string: The connection endpoint for the DB cluster.
Port string: The port number that will accept connections on this DB cluster.

address String: The connection endpoint for the DB cluster.
port String: The port number that will accept connections on this DB cluster.

address string: The connection endpoint for the DB cluster.
port string: The port number that will accept connections on this DB cluster.

address str: The connection endpoint for the DB cluster.
port str: The port number that will accept connections on this DB cluster.

address String: The connection endpoint for the DB cluster.
port String: The port number that will accept connections on this DB cluster.

DBClusterMasterUserSecret

KmsKeyId string: The AWS KMS key identifier that is used to encrypt the secret.
SecretArn string: The Amazon Resource Name (ARN) of the secret.

KmsKeyId string: The AWS KMS key identifier that is used to encrypt the secret.
SecretArn string: The Amazon Resource Name (ARN) of the secret.

kmsKeyId String: The AWS KMS key identifier that is used to encrypt the secret.
secretArn String: The Amazon Resource Name (ARN) of the secret.

kmsKeyId string: The AWS KMS key identifier that is used to encrypt the secret.
secretArn string: The Amazon Resource Name (ARN) of the secret.

kms_key_id str: The AWS KMS key identifier that is used to encrypt the secret.
secret_arn str: The Amazon Resource Name (ARN) of the secret.

kmsKeyId String: The AWS KMS key identifier that is used to encrypt the secret.
secretArn String: The Amazon Resource Name (ARN) of the secret.

DBClusterReadEndpoint

Address string: The reader endpoint for the DB cluster.

Address string: The reader endpoint for the DB cluster.

address String: The reader endpoint for the DB cluster.

address string: The reader endpoint for the DB cluster.

address str: The reader endpoint for the DB cluster.

address String: The reader endpoint for the DB cluster.

DBClusterRole

RoleArn string: The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.
FeatureName string: The name of the feature associated with the AWS Identity and Access Management (IAM) role. For the list of supported feature names, see DBEngineVersion in the Amazon RDS API Reference.

RoleArn string: The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.
FeatureName string: The name of the feature associated with the AWS Identity and Access Management (IAM) role. For the list of supported feature names, see DBEngineVersion in the Amazon RDS API Reference.

roleArn String: The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.
featureName String: The name of the feature associated with the AWS Identity and Access Management (IAM) role. For the list of supported feature names, see DBEngineVersion in the Amazon RDS API Reference.

roleArn string: The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.
featureName string: The name of the feature associated with the AWS Identity and Access Management (IAM) role. For the list of supported feature names, see DBEngineVersion in the Amazon RDS API Reference.

role_arn str: The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.
feature_name str: The name of the feature associated with the AWS Identity and Access Management (IAM) role. For the list of supported feature names, see DBEngineVersion in the Amazon RDS API Reference.

roleArn String: The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.
featureName String: The name of the feature associated with the AWS Identity and Access Management (IAM) role. For the list of supported feature names, see DBEngineVersion in the Amazon RDS API Reference.

DBClusterScalingConfiguration

AutoPause bool

A value that indicates whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode. A DB cluster can be paused only when it's idle (it has no connections).

MaxCapacity int

The maximum capacity for an Aurora DB cluster in serverless DB engine mode. For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256. For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384. The maximum capacity must be greater than or equal to the minimum capacity.

MinCapacity int

The minimum capacity for an Aurora DB cluster in serverless DB engine mode. For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256. For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384. The minimum capacity must be less than or equal to the maximum capacity.

SecondsBeforeTimeout int

The amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point to perform seamless scaling before enforcing the timeout action. The default is 300.

SecondsUntilAutoPause int

The time, in seconds, before an Aurora DB cluster in serverless mode is paused.

TimeoutAction string

The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange. ForceApplyCapacityChange sets the capacity to the specified value as soon as possible. RollbackCapacityChange, the default, ignores the capacity change if a scaling point isn't found in the timeout period.

For more information, see Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide.

AutoPause bool

A value that indicates whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode. A DB cluster can be paused only when it's idle (it has no connections).

MaxCapacity int

MinCapacity int

SecondsBeforeTimeout int

The amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point to perform seamless scaling before enforcing the timeout action. The default is 300.

SecondsUntilAutoPause int

The time, in seconds, before an Aurora DB cluster in serverless mode is paused.

TimeoutAction string

For more information, see Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide.

autoPause Boolean

A value that indicates whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode. A DB cluster can be paused only when it's idle (it has no connections).

maxCapacity Integer

minCapacity Integer

secondsBeforeTimeout Integer

The amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point to perform seamless scaling before enforcing the timeout action. The default is 300.

secondsUntilAutoPause Integer

The time, in seconds, before an Aurora DB cluster in serverless mode is paused.

timeoutAction String

For more information, see Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide.

autoPause boolean

A value that indicates whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode. A DB cluster can be paused only when it's idle (it has no connections).

maxCapacity number

minCapacity number

secondsBeforeTimeout number

The amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point to perform seamless scaling before enforcing the timeout action. The default is 300.

secondsUntilAutoPause number

The time, in seconds, before an Aurora DB cluster in serverless mode is paused.

timeoutAction string

For more information, see Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide.

auto_pause bool

A value that indicates whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode. A DB cluster can be paused only when it's idle (it has no connections).

max_capacity int

min_capacity int

seconds_before_timeout int

The amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point to perform seamless scaling before enforcing the timeout action. The default is 300.

seconds_until_auto_pause int

The time, in seconds, before an Aurora DB cluster in serverless mode is paused.

timeout_action str

For more information, see Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide.

autoPause Boolean

A value that indicates whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode. A DB cluster can be paused only when it's idle (it has no connections).

maxCapacity Number

minCapacity Number

secondsBeforeTimeout Number

The amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point to perform seamless scaling before enforcing the timeout action. The default is 300.

secondsUntilAutoPause Number

The time, in seconds, before an Aurora DB cluster in serverless mode is paused.

timeoutAction String

For more information, see Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide.

DBClusterServerlessV2ScalingConfiguration

MaxCapacity double: The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 40, 40.5, 41, and so on. The largest value that you can use is 128.
MinCapacity double: The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value that you can use is 0.5.

MaxCapacity float64: The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 40, 40.5, 41, and so on. The largest value that you can use is 128.
MinCapacity float64: The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value that you can use is 0.5.

maxCapacity Double: The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 40, 40.5, 41, and so on. The largest value that you can use is 128.
minCapacity Double: The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value that you can use is 0.5.

maxCapacity number: The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 40, 40.5, 41, and so on. The largest value that you can use is 128.
minCapacity number: The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value that you can use is 0.5.

max_capacity float: The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 40, 40.5, 41, and so on. The largest value that you can use is 128.
min_capacity float: The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value that you can use is 0.5.

maxCapacity Number: The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 40, 40.5, 41, and so on. The largest value that you can use is 128.
minCapacity Number: The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value that you can use is 0.5.

DBClusterTag

Key string: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
Value string: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

Key string: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
Value string: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

key String: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
value String: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

key string: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
value string: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

key str: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
value str: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

key String: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
value String: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

Package Details

Repository: AWS Native pulumi/pulumi-aws-native
License: Apache-2.0

aws-native.rds.getDBCluster

Using getDBCluster

getDBCluster Result

Supporting Types

DBClusterEndpoint

DBClusterMasterUserSecret

DBClusterReadEndpoint

DBClusterRole

DBClusterScalingConfiguration

DBClusterServerlessV2ScalingConfiguration

DBClusterTag

Package Details

On this page