Azure Native v2.73.0, Nov 20 24

This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.

Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi

pulumi/pulumi-azure-native

azure-native.awsconnector.getRdsDbCluster

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.

Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi

pulumi/pulumi-azure-native

Using getRdsDbCluster

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 getRdsDbCluster(args: GetRdsDbClusterArgs, opts?: InvokeOptions): Promise<GetRdsDbClusterResult>
function getRdsDbClusterOutput(args: GetRdsDbClusterOutputArgs, opts?: InvokeOptions): Output<GetRdsDbClusterResult>

def get_rds_db_cluster(name: Optional[str] = None,
                       resource_group_name: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetRdsDbClusterResult
def get_rds_db_cluster_output(name: Optional[pulumi.Input[str]] = None,
                       resource_group_name: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetRdsDbClusterResult]

func LookupRdsDbCluster(ctx *Context, args *LookupRdsDbClusterArgs, opts ...InvokeOption) (*LookupRdsDbClusterResult, error)
func LookupRdsDbClusterOutput(ctx *Context, args *LookupRdsDbClusterOutputArgs, opts ...InvokeOption) LookupRdsDbClusterResultOutput

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

public static class GetRdsDbCluster 
{
    public static Task<GetRdsDbClusterResult> InvokeAsync(GetRdsDbClusterArgs args, InvokeOptions? opts = null)
    public static Output<GetRdsDbClusterResult> Invoke(GetRdsDbClusterInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetRdsDbClusterResult> getRdsDbCluster(GetRdsDbClusterArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: azure-native:awsconnector:getRdsDbCluster
  arguments:
    # arguments dictionary

The following arguments are supported:

Name string: Name of RdsDBCluster
ResourceGroupName string: The name of the resource group. The name is case insensitive.

Name string: Name of RdsDBCluster
ResourceGroupName string: The name of the resource group. The name is case insensitive.

name String: Name of RdsDBCluster
resourceGroupName String: The name of the resource group. The name is case insensitive.

name string: Name of RdsDBCluster
resourceGroupName string: The name of the resource group. The name is case insensitive.

name str: Name of RdsDBCluster
resource_group_name str: The name of the resource group. The name is case insensitive.

name String: Name of RdsDBCluster
resourceGroupName String: The name of the resource group. The name is case insensitive.

getRdsDbCluster Result

The following output properties are available:

Id string: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
Location string: The geo-location where the resource lives
Name string: The name of the resource
Properties Pulumi.AzureNative.AwsConnector.Outputs.RdsDBClusterPropertiesResponse: The resource-specific properties for this resource.
SystemData Pulumi.AzureNative.AwsConnector.Outputs.SystemDataResponse: Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Tags Dictionary<string, string>: Resource tags.

Id string: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
Location string: The geo-location where the resource lives
Name string: The name of the resource
Properties RdsDBClusterPropertiesResponse: The resource-specific properties for this resource.
SystemData SystemDataResponse: Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Tags map[string]string: Resource tags.

id String: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location String: The geo-location where the resource lives
name String: The name of the resource
properties RdsDBClusterPropertiesResponse: The resource-specific properties for this resource.
systemData SystemDataResponse: Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
tags Map<String,String>: Resource tags.

id string: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location string: The geo-location where the resource lives
name string: The name of the resource
properties RdsDBClusterPropertiesResponse: The resource-specific properties for this resource.
systemData SystemDataResponse: Azure Resource Manager metadata containing createdBy and modifiedBy information.
type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
tags {[key: string]: string}: Resource tags.

id str: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location str: The geo-location where the resource lives
name str: The name of the resource
properties RdsDBClusterPropertiesResponse: The resource-specific properties for this resource.
system_data SystemDataResponse: Azure Resource Manager metadata containing createdBy and modifiedBy information.
type str: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
tags Mapping[str, str]: Resource tags.

id String: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location String: The geo-location where the resource lives
name String: The name of the resource
properties Property Map: The resource-specific properties for this resource.
systemData Property Map: Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
tags Map<String>: Resource tags.

Supporting Types

AwsRdsDBClusterPropertiesResponse

AllocatedStorage int: The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.
AssociatedRoles List<Pulumi.AzureNative.AwsConnector.Inputs.DBClusterRoleResponse>: 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.
AvailabilityZones List<string>: A list of Availability Zones (AZs) where instances in the DB cluster can be created. For information on AWS Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide.
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.
DatabaseName string: The name of your database. If you don't provide a name, then Amazon RDS won't create a database in this DB cluster. For naming constraints, see Naming Constraints in the Amazon RDS User Guide.
DbClusterArn string: The Amazon Resource Name (ARN) for the DB cluster.
DbClusterIdentifier string: The DB cluster identifier. This parameter is stored as a lowercase string.
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.
DbInstanceParameterGroupName string: The name of the DB parameter group to apply to all instances of the DB cluster.
DbSubnetGroupName string: A DB subnet group that you want to associate with this DB cluster.
DbSystemId string: Reserved for future use.
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.AzureNative.AwsConnector.Inputs.RdsDbClusterEndpointResponse: Property endpoint
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
EngineMode string: The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster.
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.
KmsKeyId string: The Amazon Resource Name (ARN) of the AWS Key Management Service master key that is used to encrypt the database instances in the DB cluster, such as arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef. If you enable the StorageEncrypted property but don't specify this property, the default master key is used. If you specify this property, you must set the StorageEncrypted property to true.
ManageMasterUserPassword bool: A value that indicates whether to manage the master user password with AWS Secrets Manager.
MasterUserPassword string: The master password for the DB instance.
MasterUserSecret Pulumi.AzureNative.AwsConnector.Inputs.MasterUserSecretResponse: 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.
PubliclyAccessible bool: A value that indicates whether the DB cluster is publicly accessible.
ReadEndpoint Pulumi.AzureNative.AwsConnector.Inputs.ReadEndpointResponse: Property readEndpoint
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.
RestoreToTime string: The date and time to restore the DB cluster to. Value must be a time in Universal Coordinated Time (UTC) format. An example: 2015-03-07T23:45:00Z
RestoreType string: The type of restore to be performed. You can specify one of the following values:full-copy - The new DB cluster is restored as a full copy of the source DB cluster.copy-on-write - The new DB cluster is restored as a clone of the source DB cluster.
ScalingConfiguration Pulumi.AzureNative.AwsConnector.Inputs.ScalingConfigurationResponse: The ScalingConfiguration property type specifies the scaling configuration of an Aurora Serverless DB cluster. The ScalingConfiguration property type specifies the scaling configuration of an Aurora Serverless DB cluster.
ServerlessV2ScalingConfiguration Pulumi.AzureNative.AwsConnector.Inputs.ServerlessV2ScalingConfigurationResponse: Contains the scaling configuration of an Aurora Serverless v2 DB cluster. Contains the scaling configuration of an Aurora Serverless v2 DB cluster.
SnapshotIdentifier string: The identifier for the DB snapshot or DB cluster snapshot to restore from.You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot.After you restore a DB cluster with a SnapshotIdentifier property, you must specify the same SnapshotIdentifier property for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the snapshot again, and the data in the database is not changed. However, if you don't specify the SnapshotIdentifier property, an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, the DB cluster is restored from the specified SnapshotIdentifier property, and the original DB cluster is deleted.
SourceDBClusterIdentifier string: The identifier of the source DB cluster from which to restore.
SourceRegion string: The AWS Region which contains the source DB cluster when replicating a DB cluster. For example, us-east-1.
StorageEncrypted bool: Indicates whether the DB instance is encrypted.If you specify the DBClusterIdentifier, SnapshotIdentifier, or SourceDBInstanceIdentifier property, don't specify this property. The value is inherited from the cluster, snapshot, or source DB instance.
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.AzureNative.AwsConnector.Inputs.TagResponse>: An array of key-value pairs to apply to this resource.
UseLatestRestorableTime bool: A value that indicates whether to restore the DB cluster to the latest restorable backup time. By default, the DB cluster is not restored to the latest restorable backup time.
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 []DBClusterRoleResponse: 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.
AvailabilityZones []string: A list of Availability Zones (AZs) where instances in the DB cluster can be created. For information on AWS Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide.
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.
DatabaseName string: The name of your database. If you don't provide a name, then Amazon RDS won't create a database in this DB cluster. For naming constraints, see Naming Constraints in the Amazon RDS User Guide.
DbClusterArn string: The Amazon Resource Name (ARN) for the DB cluster.
DbClusterIdentifier string: The DB cluster identifier. This parameter is stored as a lowercase string.
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.
DbInstanceParameterGroupName string: The name of the DB parameter group to apply to all instances of the DB cluster.
DbSubnetGroupName string: A DB subnet group that you want to associate with this DB cluster.
DbSystemId string: Reserved for future use.
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 RdsDbClusterEndpointResponse: Property endpoint
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
EngineMode string: The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster.
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.
KmsKeyId string: The Amazon Resource Name (ARN) of the AWS Key Management Service master key that is used to encrypt the database instances in the DB cluster, such as arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef. If you enable the StorageEncrypted property but don't specify this property, the default master key is used. If you specify this property, you must set the StorageEncrypted property to true.
ManageMasterUserPassword bool: A value that indicates whether to manage the master user password with AWS Secrets Manager.
MasterUserPassword string: The master password for the DB instance.
MasterUserSecret MasterUserSecretResponse: 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.
PubliclyAccessible bool: A value that indicates whether the DB cluster is publicly accessible.
ReadEndpoint ReadEndpointResponse: Property readEndpoint
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.
RestoreToTime string: The date and time to restore the DB cluster to. Value must be a time in Universal Coordinated Time (UTC) format. An example: 2015-03-07T23:45:00Z
RestoreType string: The type of restore to be performed. You can specify one of the following values:full-copy - The new DB cluster is restored as a full copy of the source DB cluster.copy-on-write - The new DB cluster is restored as a clone of the source DB cluster.
ScalingConfiguration ScalingConfigurationResponse: The ScalingConfiguration property type specifies the scaling configuration of an Aurora Serverless DB cluster. The ScalingConfiguration property type specifies the scaling configuration of an Aurora Serverless DB cluster.
ServerlessV2ScalingConfiguration ServerlessV2ScalingConfigurationResponse: Contains the scaling configuration of an Aurora Serverless v2 DB cluster. Contains the scaling configuration of an Aurora Serverless v2 DB cluster.
SnapshotIdentifier string: The identifier for the DB snapshot or DB cluster snapshot to restore from.You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot.After you restore a DB cluster with a SnapshotIdentifier property, you must specify the same SnapshotIdentifier property for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the snapshot again, and the data in the database is not changed. However, if you don't specify the SnapshotIdentifier property, an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, the DB cluster is restored from the specified SnapshotIdentifier property, and the original DB cluster is deleted.
SourceDBClusterIdentifier string: The identifier of the source DB cluster from which to restore.
SourceRegion string: The AWS Region which contains the source DB cluster when replicating a DB cluster. For example, us-east-1.
StorageEncrypted bool: Indicates whether the DB instance is encrypted.If you specify the DBClusterIdentifier, SnapshotIdentifier, or SourceDBInstanceIdentifier property, don't specify this property. The value is inherited from the cluster, snapshot, or source DB instance.
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 []TagResponse: An array of key-value pairs to apply to this resource.
UseLatestRestorableTime bool: A value that indicates whether to restore the DB cluster to the latest restorable backup time. By default, the DB cluster is not restored to the latest restorable backup time.
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<DBClusterRoleResponse>: 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.
availabilityZones List<String>: A list of Availability Zones (AZs) where instances in the DB cluster can be created. For information on AWS Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide.
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.
databaseName String: The name of your database. If you don't provide a name, then Amazon RDS won't create a database in this DB cluster. For naming constraints, see Naming Constraints in the Amazon RDS User Guide.
dbClusterArn String: The Amazon Resource Name (ARN) for the DB cluster.
dbClusterIdentifier String: The DB cluster identifier. This parameter is stored as a lowercase string.
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.
dbInstanceParameterGroupName String: The name of the DB parameter group to apply to all instances of the DB cluster.
dbSubnetGroupName String: A DB subnet group that you want to associate with this DB cluster.
dbSystemId String: Reserved for future use.
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 RdsDbClusterEndpointResponse: Property endpoint
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
engineMode String: The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster.
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.
kmsKeyId String: The Amazon Resource Name (ARN) of the AWS Key Management Service master key that is used to encrypt the database instances in the DB cluster, such as arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef. If you enable the StorageEncrypted property but don't specify this property, the default master key is used. If you specify this property, you must set the StorageEncrypted property to true.
manageMasterUserPassword Boolean: A value that indicates whether to manage the master user password with AWS Secrets Manager.
masterUserPassword String: The master password for the DB instance.
masterUserSecret MasterUserSecretResponse: 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.
publiclyAccessible Boolean: A value that indicates whether the DB cluster is publicly accessible.
readEndpoint ReadEndpointResponse: Property readEndpoint
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.
restoreToTime String: The date and time to restore the DB cluster to. Value must be a time in Universal Coordinated Time (UTC) format. An example: 2015-03-07T23:45:00Z
restoreType String: The type of restore to be performed. You can specify one of the following values:full-copy - The new DB cluster is restored as a full copy of the source DB cluster.copy-on-write - The new DB cluster is restored as a clone of the source DB cluster.
scalingConfiguration ScalingConfigurationResponse: The ScalingConfiguration property type specifies the scaling configuration of an Aurora Serverless DB cluster. The ScalingConfiguration property type specifies the scaling configuration of an Aurora Serverless DB cluster.
serverlessV2ScalingConfiguration ServerlessV2ScalingConfigurationResponse: Contains the scaling configuration of an Aurora Serverless v2 DB cluster. Contains the scaling configuration of an Aurora Serverless v2 DB cluster.
snapshotIdentifier String: The identifier for the DB snapshot or DB cluster snapshot to restore from.You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot.After you restore a DB cluster with a SnapshotIdentifier property, you must specify the same SnapshotIdentifier property for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the snapshot again, and the data in the database is not changed. However, if you don't specify the SnapshotIdentifier property, an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, the DB cluster is restored from the specified SnapshotIdentifier property, and the original DB cluster is deleted.
sourceDBClusterIdentifier String: The identifier of the source DB cluster from which to restore.
sourceRegion String: The AWS Region which contains the source DB cluster when replicating a DB cluster. For example, us-east-1.
storageEncrypted Boolean: Indicates whether the DB instance is encrypted.If you specify the DBClusterIdentifier, SnapshotIdentifier, or SourceDBInstanceIdentifier property, don't specify this property. The value is inherited from the cluster, snapshot, or source DB instance.
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<TagResponse>: An array of key-value pairs to apply to this resource.
useLatestRestorableTime Boolean: A value that indicates whether to restore the DB cluster to the latest restorable backup time. By default, the DB cluster is not restored to the latest restorable backup time.
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 DBClusterRoleResponse[]: 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.
availabilityZones string[]: A list of Availability Zones (AZs) where instances in the DB cluster can be created. For information on AWS Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide.
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.
databaseName string: The name of your database. If you don't provide a name, then Amazon RDS won't create a database in this DB cluster. For naming constraints, see Naming Constraints in the Amazon RDS User Guide.
dbClusterArn string: The Amazon Resource Name (ARN) for the DB cluster.
dbClusterIdentifier string: The DB cluster identifier. This parameter is stored as a lowercase string.
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.
dbInstanceParameterGroupName string: The name of the DB parameter group to apply to all instances of the DB cluster.
dbSubnetGroupName string: A DB subnet group that you want to associate with this DB cluster.
dbSystemId string: Reserved for future use.
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 RdsDbClusterEndpointResponse: Property endpoint
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
engineMode string: The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster.
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.
kmsKeyId string: The Amazon Resource Name (ARN) of the AWS Key Management Service master key that is used to encrypt the database instances in the DB cluster, such as arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef. If you enable the StorageEncrypted property but don't specify this property, the default master key is used. If you specify this property, you must set the StorageEncrypted property to true.
manageMasterUserPassword boolean: A value that indicates whether to manage the master user password with AWS Secrets Manager.
masterUserPassword string: The master password for the DB instance.
masterUserSecret MasterUserSecretResponse: 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.
publiclyAccessible boolean: A value that indicates whether the DB cluster is publicly accessible.
readEndpoint ReadEndpointResponse: Property readEndpoint
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.
restoreToTime string: The date and time to restore the DB cluster to. Value must be a time in Universal Coordinated Time (UTC) format. An example: 2015-03-07T23:45:00Z
restoreType string: The type of restore to be performed. You can specify one of the following values:full-copy - The new DB cluster is restored as a full copy of the source DB cluster.copy-on-write - The new DB cluster is restored as a clone of the source DB cluster.
scalingConfiguration ScalingConfigurationResponse: The ScalingConfiguration property type specifies the scaling configuration of an Aurora Serverless DB cluster. The ScalingConfiguration property type specifies the scaling configuration of an Aurora Serverless DB cluster.
serverlessV2ScalingConfiguration ServerlessV2ScalingConfigurationResponse: Contains the scaling configuration of an Aurora Serverless v2 DB cluster. Contains the scaling configuration of an Aurora Serverless v2 DB cluster.
snapshotIdentifier string: The identifier for the DB snapshot or DB cluster snapshot to restore from.You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot.After you restore a DB cluster with a SnapshotIdentifier property, you must specify the same SnapshotIdentifier property for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the snapshot again, and the data in the database is not changed. However, if you don't specify the SnapshotIdentifier property, an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, the DB cluster is restored from the specified SnapshotIdentifier property, and the original DB cluster is deleted.
sourceDBClusterIdentifier string: The identifier of the source DB cluster from which to restore.
sourceRegion string: The AWS Region which contains the source DB cluster when replicating a DB cluster. For example, us-east-1.
storageEncrypted boolean: Indicates whether the DB instance is encrypted.If you specify the DBClusterIdentifier, SnapshotIdentifier, or SourceDBInstanceIdentifier property, don't specify this property. The value is inherited from the cluster, snapshot, or source DB instance.
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 TagResponse[]: An array of key-value pairs to apply to this resource.
useLatestRestorableTime boolean: A value that indicates whether to restore the DB cluster to the latest restorable backup time. By default, the DB cluster is not restored to the latest restorable backup time.
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[DBClusterRoleResponse]: 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.
availability_zones Sequence[str]: A list of Availability Zones (AZs) where instances in the DB cluster can be created. For information on AWS Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide.
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.
database_name str: The name of your database. If you don't provide a name, then Amazon RDS won't create a database in this DB cluster. For naming constraints, see Naming Constraints in the Amazon RDS User Guide.
db_cluster_arn str: The Amazon Resource Name (ARN) for the DB cluster.
db_cluster_identifier str: The DB cluster identifier. This parameter is stored as a lowercase string.
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.
db_instance_parameter_group_name str: The name of the DB parameter group to apply to all instances of the DB cluster.
db_subnet_group_name str: A DB subnet group that you want to associate with this DB cluster.
db_system_id str: Reserved for future use.
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 RdsDbClusterEndpointResponse: Property endpoint
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_mode str: The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster.
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.
kms_key_id str: The Amazon Resource Name (ARN) of the AWS Key Management Service master key that is used to encrypt the database instances in the DB cluster, such as arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef. If you enable the StorageEncrypted property but don't specify this property, the default master key is used. If you specify this property, you must set the StorageEncrypted property to true.
manage_master_user_password bool: A value that indicates whether to manage the master user password with AWS Secrets Manager.
master_user_password str: The master password for the DB instance.
master_user_secret MasterUserSecretResponse: 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.
publicly_accessible bool: A value that indicates whether the DB cluster is publicly accessible.
read_endpoint ReadEndpointResponse: Property readEndpoint
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.
restore_to_time str: The date and time to restore the DB cluster to. Value must be a time in Universal Coordinated Time (UTC) format. An example: 2015-03-07T23:45:00Z
restore_type str: The type of restore to be performed. You can specify one of the following values:full-copy - The new DB cluster is restored as a full copy of the source DB cluster.copy-on-write - The new DB cluster is restored as a clone of the source DB cluster.
scaling_configuration ScalingConfigurationResponse: The ScalingConfiguration property type specifies the scaling configuration of an Aurora Serverless DB cluster. The ScalingConfiguration property type specifies the scaling configuration of an Aurora Serverless DB cluster.
serverless_v2_scaling_configuration ServerlessV2ScalingConfigurationResponse: Contains the scaling configuration of an Aurora Serverless v2 DB cluster. Contains the scaling configuration of an Aurora Serverless v2 DB cluster.
snapshot_identifier str: The identifier for the DB snapshot or DB cluster snapshot to restore from.You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot.After you restore a DB cluster with a SnapshotIdentifier property, you must specify the same SnapshotIdentifier property for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the snapshot again, and the data in the database is not changed. However, if you don't specify the SnapshotIdentifier property, an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, the DB cluster is restored from the specified SnapshotIdentifier property, and the original DB cluster is deleted.
source_db_cluster_identifier str: The identifier of the source DB cluster from which to restore.
source_region str: The AWS Region which contains the source DB cluster when replicating a DB cluster. For example, us-east-1.
storage_encrypted bool: Indicates whether the DB instance is encrypted.If you specify the DBClusterIdentifier, SnapshotIdentifier, or SourceDBInstanceIdentifier property, don't specify this property. The value is inherited from the cluster, snapshot, or source DB instance.
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[TagResponse]: An array of key-value pairs to apply to this resource.
use_latest_restorable_time bool: A value that indicates whether to restore the DB cluster to the latest restorable backup time. By default, the DB cluster is not restored to the latest restorable backup time.
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.
availabilityZones List<String>: A list of Availability Zones (AZs) where instances in the DB cluster can be created. For information on AWS Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide.
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.
databaseName String: The name of your database. If you don't provide a name, then Amazon RDS won't create a database in this DB cluster. For naming constraints, see Naming Constraints in the Amazon RDS User Guide.
dbClusterArn String: The Amazon Resource Name (ARN) for the DB cluster.
dbClusterIdentifier String: The DB cluster identifier. This parameter is stored as a lowercase string.
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.
dbInstanceParameterGroupName String: The name of the DB parameter group to apply to all instances of the DB cluster.
dbSubnetGroupName String: A DB subnet group that you want to associate with this DB cluster.
dbSystemId String: Reserved for future use.
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: Property endpoint
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
engineMode String: The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster.
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.
kmsKeyId String: The Amazon Resource Name (ARN) of the AWS Key Management Service master key that is used to encrypt the database instances in the DB cluster, such as arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef. If you enable the StorageEncrypted property but don't specify this property, the default master key is used. If you specify this property, you must set the StorageEncrypted property to true.
manageMasterUserPassword Boolean: A value that indicates whether to manage the master user password with AWS Secrets Manager.
masterUserPassword String: The master password for the DB instance.
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.
publiclyAccessible Boolean: A value that indicates whether the DB cluster is publicly accessible.
readEndpoint Property Map: Property readEndpoint
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.
restoreToTime String: The date and time to restore the DB cluster to. Value must be a time in Universal Coordinated Time (UTC) format. An example: 2015-03-07T23:45:00Z
restoreType String: The type of restore to be performed. You can specify one of the following values:full-copy - The new DB cluster is restored as a full copy of the source DB cluster.copy-on-write - The new DB cluster is restored as a clone of the source DB cluster.
scalingConfiguration Property Map: The ScalingConfiguration property type specifies the scaling configuration of an Aurora Serverless DB cluster. 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. Contains the scaling configuration of an Aurora Serverless v2 DB cluster.
snapshotIdentifier String: The identifier for the DB snapshot or DB cluster snapshot to restore from.You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot.After you restore a DB cluster with a SnapshotIdentifier property, you must specify the same SnapshotIdentifier property for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the snapshot again, and the data in the database is not changed. However, if you don't specify the SnapshotIdentifier property, an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, the DB cluster is restored from the specified SnapshotIdentifier property, and the original DB cluster is deleted.
sourceDBClusterIdentifier String: The identifier of the source DB cluster from which to restore.
sourceRegion String: The AWS Region which contains the source DB cluster when replicating a DB cluster. For example, us-east-1.
storageEncrypted Boolean: Indicates whether the DB instance is encrypted.If you specify the DBClusterIdentifier, SnapshotIdentifier, or SourceDBInstanceIdentifier property, don't specify this property. The value is inherited from the cluster, snapshot, or source DB instance.
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.
useLatestRestorableTime Boolean: A value that indicates whether to restore the DB cluster to the latest restorable backup time. By default, the DB cluster is not restored to the latest restorable backup time.
vpcSecurityGroupIds List<String>: A list of EC2 VPC security groups to associate with this DB cluster.

DBClusterRoleResponse

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.
roleArn string: 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.
role_arn str: 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.

MasterUserSecretResponse

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.

RdsDBClusterPropertiesResponse

ProvisioningState string: The status of the last operation.
Arn string: Amazon Resource Name (ARN)
AwsAccountId string: AWS Account ID
AwsProperties Pulumi.AzureNative.AwsConnector.Inputs.AwsRdsDBClusterPropertiesResponse: AWS Properties
AwsRegion string: AWS Region
AwsSourceSchema string: AWS Source Schema
AwsTags Dictionary<string, string>: AWS Tags
PublicCloudConnectorsResourceId string: Public Cloud Connectors Resource ID
PublicCloudResourceName string: Public Cloud Resource Name

ProvisioningState string: The status of the last operation.
Arn string: Amazon Resource Name (ARN)
AwsAccountId string: AWS Account ID
AwsProperties AwsRdsDBClusterPropertiesResponse: AWS Properties
AwsRegion string: AWS Region
AwsSourceSchema string: AWS Source Schema
AwsTags map[string]string: AWS Tags
PublicCloudConnectorsResourceId string: Public Cloud Connectors Resource ID
PublicCloudResourceName string: Public Cloud Resource Name

provisioningState String: The status of the last operation.
arn String: Amazon Resource Name (ARN)
awsAccountId String: AWS Account ID
awsProperties AwsRdsDBClusterPropertiesResponse: AWS Properties
awsRegion String: AWS Region
awsSourceSchema String: AWS Source Schema
awsTags Map<String,String>: AWS Tags
publicCloudConnectorsResourceId String: Public Cloud Connectors Resource ID
publicCloudResourceName String: Public Cloud Resource Name

provisioningState string: The status of the last operation.
arn string: Amazon Resource Name (ARN)
awsAccountId string: AWS Account ID
awsProperties AwsRdsDBClusterPropertiesResponse: AWS Properties
awsRegion string: AWS Region
awsSourceSchema string: AWS Source Schema
awsTags {[key: string]: string}: AWS Tags
publicCloudConnectorsResourceId string: Public Cloud Connectors Resource ID
publicCloudResourceName string: Public Cloud Resource Name

provisioning_state str: The status of the last operation.
arn str: Amazon Resource Name (ARN)
aws_account_id str: AWS Account ID
aws_properties AwsRdsDBClusterPropertiesResponse: AWS Properties
aws_region str: AWS Region
aws_source_schema str: AWS Source Schema
aws_tags Mapping[str, str]: AWS Tags
public_cloud_connectors_resource_id str: Public Cloud Connectors Resource ID
public_cloud_resource_name str: Public Cloud Resource Name

provisioningState String: The status of the last operation.
arn String: Amazon Resource Name (ARN)
awsAccountId String: AWS Account ID
awsProperties Property Map: AWS Properties
awsRegion String: AWS Region
awsSourceSchema String: AWS Source Schema
awsTags Map<String>: AWS Tags
publicCloudConnectorsResourceId String: Public Cloud Connectors Resource ID
publicCloudResourceName String: Public Cloud Resource Name

RdsDbClusterEndpointResponse

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.

ReadEndpointResponse

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.

ScalingConfigurationResponse

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.

ServerlessV2ScalingConfigurationResponse

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.

SystemDataResponse

CreatedAt string: The timestamp of resource creation (UTC).
CreatedBy string: The identity that created the resource.
CreatedByType string: The type of identity that created the resource.
LastModifiedAt string: The timestamp of resource last modification (UTC)
LastModifiedBy string: The identity that last modified the resource.
LastModifiedByType string: The type of identity that last modified the resource.

CreatedAt string: The timestamp of resource creation (UTC).
CreatedBy string: The identity that created the resource.
CreatedByType string: The type of identity that created the resource.
LastModifiedAt string: The timestamp of resource last modification (UTC)
LastModifiedBy string: The identity that last modified the resource.
LastModifiedByType string: The type of identity that last modified the resource.

createdAt String: The timestamp of resource creation (UTC).
createdBy String: The identity that created the resource.
createdByType String: The type of identity that created the resource.
lastModifiedAt String: The timestamp of resource last modification (UTC)
lastModifiedBy String: The identity that last modified the resource.
lastModifiedByType String: The type of identity that last modified the resource.

createdAt string: The timestamp of resource creation (UTC).
createdBy string: The identity that created the resource.
createdByType string: The type of identity that created the resource.
lastModifiedAt string: The timestamp of resource last modification (UTC)
lastModifiedBy string: The identity that last modified the resource.
lastModifiedByType string: The type of identity that last modified the resource.

created_at str: The timestamp of resource creation (UTC).
created_by str: The identity that created the resource.
created_by_type str: The type of identity that created the resource.
last_modified_at str: The timestamp of resource last modification (UTC)
last_modified_by str: The identity that last modified the resource.
last_modified_by_type str: The type of identity that last modified the resource.

createdAt String: The timestamp of resource creation (UTC).
createdBy String: The identity that created the resource.
createdByType String: The type of identity that created the resource.
lastModifiedAt String: The timestamp of resource last modification (UTC)
lastModifiedBy String: The identity that last modified the resource.
lastModifiedByType String: The type of identity that last modified the resource.

TagResponse

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: Azure Native pulumi/pulumi-azure-native
License: Apache-2.0

This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.

Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi

pulumi/pulumi-azure-native

azure-native.awsconnector.getRdsDbCluster

On this page

On this page

Using getRdsDbCluster

getRdsDbCluster Result

Supporting Types

AwsRdsDBClusterPropertiesResponse

DBClusterRoleResponse

MasterUserSecretResponse

RdsDBClusterPropertiesResponse

RdsDbClusterEndpointResponse

ReadEndpointResponse

ScalingConfigurationResponse

ServerlessV2ScalingConfigurationResponse

SystemDataResponse

TagResponse

Package Details

On this page

On this page