Docs Packages
  1. Packages
  2. AWS Native
  3. API Docs
  4. rds
  5. getDbCluster

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.rds.getDbCluster

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi
pulumi/pulumi-aws-native

    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(db_cluster_identifier: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetDbClusterResult
def get_db_cluster_output(db_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.
    db_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.DbClusterDbClusterRole>
    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.
    EnableGlobalWriteForwarding bool
    Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster (Aurora global database). By default, write operations are not allowed on Aurora DB clusters that are secondary clusters in an Aurora global database.
    EnableHttpEndpoint bool
    A value that indicates whether to enable the HTTP endpoint for 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.
    StorageThroughput int
    Specifies the storage throughput value for the DB cluster. This setting applies only to the gp3 storage type.
    StorageType string
    Specifies the storage type to be associated with the DB cluster.
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    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 []DbClusterDbClusterRole
    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 []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.
    EnableGlobalWriteForwarding bool
    Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster (Aurora global database). By default, write operations are not allowed on Aurora DB clusters that are secondary clusters in an Aurora global database.
    EnableHttpEndpoint bool
    A value that indicates whether to enable the HTTP endpoint for 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 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 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 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.
    StorageThroughput int
    Specifies the storage throughput value for the DB cluster. This setting applies only to the gp3 storage type.
    StorageType string
    Specifies the storage type to be associated with the DB cluster.
    Tags Tag
    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<DbClusterDbClusterRole>
    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 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>
    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.
    enableGlobalWriteForwarding Boolean
    Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster (Aurora global database). By default, write operations are not allowed on Aurora DB clusters that are secondary clusters in an Aurora global database.
    enableHttpEndpoint Boolean
    A value that indicates whether to enable the HTTP endpoint for 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 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 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
    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 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.
    storageThroughput Integer
    Specifies the storage throughput value for the DB cluster. This setting applies only to the gp3 storage type.
    storageType String
    Specifies the storage type to be associated with the DB cluster.
    tags List<Tag>
    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 DbClusterDbClusterRole[]
    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 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[]
    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.
    enableGlobalWriteForwarding boolean
    Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster (Aurora global database). By default, write operations are not allowed on Aurora DB clusters that are secondary clusters in an Aurora global database.
    enableHttpEndpoint boolean
    A value that indicates whether to enable the HTTP endpoint for 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 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 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
    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 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.
    storageThroughput number
    Specifies the storage throughput value for the DB cluster. This setting applies only to the gp3 storage type.
    storageType string
    Specifies the storage type to be associated with the DB cluster.
    tags Tag[]
    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[DbClusterDbClusterRole]
    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.
    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.
    db_cluster_arn str
    The Amazon Resource Name (ARN) for the DB cluster.
    db_cluster_instance_class str
    The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge.
    db_cluster_parameter_group_name str
    The name of the DB cluster parameter group to associate with this DB cluster.
    db_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]
    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.
    enable_global_write_forwarding bool
    Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster (Aurora global database). By default, write operations are not allowed on Aurora DB clusters that are secondary clusters in an Aurora global database.
    enable_http_endpoint bool
    A value that indicates whether to enable the HTTP endpoint for 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 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.
    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
    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.
    preferred_maintenance_window str
    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.
    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_throughput int
    Specifies the storage throughput value for the DB cluster. This setting applies only to the gp3 storage type.
    storage_type str
    Specifies the storage type to be associated with the DB cluster.
    tags Sequence[root_Tag]
    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>
    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 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>
    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.
    enableGlobalWriteForwarding Boolean
    Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster (Aurora global database). By default, write operations are not allowed on Aurora DB clusters that are secondary clusters in an Aurora global database.
    enableHttpEndpoint Boolean
    A value that indicates whether to enable the HTTP endpoint for 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 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 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
    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 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.
    storageThroughput Number
    Specifies the storage throughput value for the DB cluster. This setting applies only to the gp3 storage type.
    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

    DbClusterDbClusterRole

    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.

    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.

    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
    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 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
    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 Integer
    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 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

    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 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
    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 number
    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 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

    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.

    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
    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.
    min_capacity 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.
    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

    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 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
    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 Number
    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 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

    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.

    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.

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

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

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi
    pulumi/pulumi-aws-native