Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. AWS
  4. API Docs
  5. rds
  6. getCluster
Viewing docs for AWS v7.50.0
published on Thursday, Oct 8, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws

aws.rds.getCluster

aws logo aws logo
Viewing docs for AWS v7.50.0
published on Thursday, Oct 8, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws

    Provides information about an RDS cluster.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const clusterName = aws.rds.getCluster({
    clusterIdentifier: "clusterName",
});

    import pulumi
import pulumi_aws as aws

cluster_name = aws.rds.get_cluster(cluster_identifier="clusterName")

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/rds"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := rds.LookupCluster(ctx, &rds.LookupClusterArgs{
			ClusterIdentifier: "clusterName",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var clusterName = Aws.Rds.GetCluster.Invoke(new()
    {
        ClusterIdentifier = "clusterName",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.rds.RdsFunctions;
import com.pulumi.aws.rds.inputs.GetClusterArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var clusterName = RdsFunctions.getCluster(GetClusterArgs.builder()
            .clusterIdentifier("clusterName")
            .build());

    }
}

    variables:
  clusterName:
    fn::invoke:
      function: aws:rds:getCluster
      arguments:
        clusterIdentifier: clusterName

    pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

data "aws_rds_getcluster" "clusterName" {
  cluster_identifier = "clusterName"
}

    Using getCluster

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

    function getCluster(args: GetClusterArgs, opts?: InvokeOptions): Promise<GetClusterResult>
function getClusterOutput(args: GetClusterOutputArgs, opts?: InvokeOutputOptions): Output<GetClusterResult>
    def get_cluster(cluster_identifier: Optional[str] = None,
                region: Optional[str] = None,
                tags: Optional[Mapping[str, str]] = None,
                opts: Optional[InvokeOptions] = None) -> GetClusterResult
def get_cluster_output(cluster_identifier: pulumi.Input[Optional[str]] = None,
                region: pulumi.Input[Optional[str]] = None,
                tags: pulumi.Input[Optional[Mapping[str, pulumi.Input[str]]]] = None,
                opts: Optional[InvokeOutputOptions] = None) -> Output[GetClusterResult]
    func LookupCluster(ctx *Context, args *LookupClusterArgs, opts ...InvokeOption) (*LookupClusterResult, error)
func LookupClusterOutput(ctx *Context, args *LookupClusterOutputArgs, opts ...InvokeOption) LookupClusterResultOutput

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

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

    fn::invoke:
  function: aws:rds/getCluster:getCluster
  arguments:
    # arguments dictionary
    data "aws_rds_get_cluster" "name" {
    # arguments
}

    The following arguments are supported:

    ClusterIdentifier string
    Cluster identifier of the RDS cluster.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    Tags Dictionary<string, string>
    Map of tags assigned to the resource.
    ClusterIdentifier string
    Cluster identifier of the RDS cluster.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    Tags map[string]string
    Map of tags assigned to the resource.
    cluster_identifier string
    Cluster identifier of the RDS cluster.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags map(string)
    Map of tags assigned to the resource.
    clusterIdentifier String
    Cluster identifier of the RDS cluster.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags Map<String,String>
    Map of tags assigned to the resource.
    clusterIdentifier string
    Cluster identifier of the RDS cluster.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags {[key: string]: string}
    Map of tags assigned to the resource.
    cluster_identifier str
    Cluster identifier of the RDS cluster.
    region str
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags Mapping[str, str]
    Map of tags assigned to the resource.
    clusterIdentifier String
    Cluster identifier of the RDS cluster.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags Map<String>
    Map of tags assigned to the resource.

    getCluster Result

    The following output properties are available:

    Arn string
    ARN of the cluster.
    AvailabilityZones List<string>
    Availability Zones of the RDS cluster.
    BacktrackWindow int
    Target backtrack window, in seconds.
    BackupRetentionPeriod int
    Days to retain backups for.
    ClusterIdentifier string
    ClusterMembers List<string>
    List of RDS Instances that are a part of this cluster.
    ClusterResourceId string
    RDS Cluster Resource ID.
    ClusterScalabilityType string
    Scalability mode of the cluster.
    DatabaseInsightsMode string
    Mode of Database Insights that is enabled for the cluster.
    DatabaseName string
    Name for an automatically created database on cluster creation.
    DbClusterParameterGroupName string
    Cluster parameter group associated with the cluster.
    DbSubnetGroupName string
    DB subnet group associated with the cluster.
    DbSystemId string
    System ID of the cluster.
    DeletionProtection bool
    Whether the cluster has deletion protection enabled.
    EnabledCloudwatchLogsExports List<string>
    List of log types exported to CloudWatch Logs.
    Endpoint string
    DNS address of the RDS instance.
    Engine string
    Database engine.
    EngineMode string
    Database engine mode.
    EngineVersion string
    Database engine version.
    FinalSnapshotIdentifier string
    Name of the final snapshot taken when the cluster is deleted.
    HostedZoneId string
    Route53 Hosted Zone ID of the endpoint.
    IamDatabaseAuthenticationEnabled bool
    Whether mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled.
    IamRoles List<string>
    IAM roles associated with the cluster.
    Id string
    The provider-assigned unique ID for this managed resource.
    KmsKeyId string
    Amazon Web Services KMS key identifier that is used to encrypt the secret.
    MasterUserSecrets List<GetClusterMasterUserSecret>
    Block that specifies the master user secret. Only available when manageMasterUserPassword is set to true. Documented below.
    MasterUsername string
    Master username for the database.
    MonitoringInterval int
    Interval, in seconds, between points when Enhanced Monitoring metrics are collected for the cluster.
    MonitoringRoleArn string
    ARN of the IAM role used by RDS to send Enhanced Monitoring metrics to CloudWatch Logs.
    NetworkType string
    Network type of the cluster.
    Port int
    Port on which the DB accepts connections.
    PreferredBackupWindow string
    Daily time range during which automated backups are created.
    PreferredMaintenanceWindow string
    Weekly time range during which system maintenance can occur.
    ReaderEndpoint string
    Read-only endpoint for the cluster, automatically load-balanced across replicas.
    Region string
    ReplicationSourceIdentifier string
    ARN of the source DB cluster or DB instance if this DB cluster is created as a read replica.
    StorageEncrypted bool
    Whether the DB cluster is encrypted.
    Tags Dictionary<string, string>
    Map of tags assigned to the resource.
    UpgradeRolloutOrder string
    Order in which minor and major version upgrades are applied to the cluster.
    VpcSecurityGroupIds List<string>
    VPC security groups the cluster belongs to.
    Arn string
    ARN of the cluster.
    AvailabilityZones []string
    Availability Zones of the RDS cluster.
    BacktrackWindow int
    Target backtrack window, in seconds.
    BackupRetentionPeriod int
    Days to retain backups for.
    ClusterIdentifier string
    ClusterMembers []string
    List of RDS Instances that are a part of this cluster.
    ClusterResourceId string
    RDS Cluster Resource ID.
    ClusterScalabilityType string
    Scalability mode of the cluster.
    DatabaseInsightsMode string
    Mode of Database Insights that is enabled for the cluster.
    DatabaseName string
    Name for an automatically created database on cluster creation.
    DbClusterParameterGroupName string
    Cluster parameter group associated with the cluster.
    DbSubnetGroupName string
    DB subnet group associated with the cluster.
    DbSystemId string
    System ID of the cluster.
    DeletionProtection bool
    Whether the cluster has deletion protection enabled.
    EnabledCloudwatchLogsExports []string
    List of log types exported to CloudWatch Logs.
    Endpoint string
    DNS address of the RDS instance.
    Engine string
    Database engine.
    EngineMode string
    Database engine mode.
    EngineVersion string
    Database engine version.
    FinalSnapshotIdentifier string
    Name of the final snapshot taken when the cluster is deleted.
    HostedZoneId string
    Route53 Hosted Zone ID of the endpoint.
    IamDatabaseAuthenticationEnabled bool
    Whether mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled.
    IamRoles []string
    IAM roles associated with the cluster.
    Id string
    The provider-assigned unique ID for this managed resource.
    KmsKeyId string
    Amazon Web Services KMS key identifier that is used to encrypt the secret.
    MasterUserSecrets []GetClusterMasterUserSecret
    Block that specifies the master user secret. Only available when manageMasterUserPassword is set to true. Documented below.
    MasterUsername string
    Master username for the database.
    MonitoringInterval int
    Interval, in seconds, between points when Enhanced Monitoring metrics are collected for the cluster.
    MonitoringRoleArn string
    ARN of the IAM role used by RDS to send Enhanced Monitoring metrics to CloudWatch Logs.
    NetworkType string
    Network type of the cluster.
    Port int
    Port on which the DB accepts connections.
    PreferredBackupWindow string
    Daily time range during which automated backups are created.
    PreferredMaintenanceWindow string
    Weekly time range during which system maintenance can occur.
    ReaderEndpoint string
    Read-only endpoint for the cluster, automatically load-balanced across replicas.
    Region string
    ReplicationSourceIdentifier string
    ARN of the source DB cluster or DB instance if this DB cluster is created as a read replica.
    StorageEncrypted bool
    Whether the DB cluster is encrypted.
    Tags map[string]string
    Map of tags assigned to the resource.
    UpgradeRolloutOrder string
    Order in which minor and major version upgrades are applied to the cluster.
    VpcSecurityGroupIds []string
    VPC security groups the cluster belongs to.
    arn string
    ARN of the cluster.
    availability_zones list(string)
    Availability Zones of the RDS cluster.
    backtrack_window number
    Target backtrack window, in seconds.
    backup_retention_period number
    Days to retain backups for.
    cluster_identifier string
    cluster_members list(string)
    List of RDS Instances that are a part of this cluster.
    cluster_resource_id string
    RDS Cluster Resource ID.
    cluster_scalability_type string
    Scalability mode of the cluster.
    database_insights_mode string
    Mode of Database Insights that is enabled for the cluster.
    database_name string
    Name for an automatically created database on cluster creation.
    db_cluster_parameter_group_name string
    Cluster parameter group associated with the cluster.
    db_subnet_group_name string
    DB subnet group associated with the cluster.
    db_system_id string
    System ID of the cluster.
    deletion_protection bool
    Whether the cluster has deletion protection enabled.
    enabled_cloudwatch_logs_exports list(string)
    List of log types exported to CloudWatch Logs.
    endpoint string
    DNS address of the RDS instance.
    engine string
    Database engine.
    engine_mode string
    Database engine mode.
    engine_version string
    Database engine version.
    final_snapshot_identifier string
    Name of the final snapshot taken when the cluster is deleted.
    hosted_zone_id string
    Route53 Hosted Zone ID of the endpoint.
    iam_database_authentication_enabled bool
    Whether mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled.
    iam_roles list(string)
    IAM roles associated with the cluster.
    id string
    The provider-assigned unique ID for this managed resource.
    kms_key_id string
    Amazon Web Services KMS key identifier that is used to encrypt the secret.
    master_user_secrets list(object)
    Block that specifies the master user secret. Only available when manageMasterUserPassword is set to true. Documented below.
    master_username string
    Master username for the database.
    monitoring_interval number
    Interval, in seconds, between points when Enhanced Monitoring metrics are collected for the cluster.
    monitoring_role_arn string
    ARN of the IAM role used by RDS to send Enhanced Monitoring metrics to CloudWatch Logs.
    network_type string
    Network type of the cluster.
    port number
    Port on which the DB accepts connections.
    preferred_backup_window string
    Daily time range during which automated backups are created.
    preferred_maintenance_window string
    Weekly time range during which system maintenance can occur.
    reader_endpoint string
    Read-only endpoint for the cluster, automatically load-balanced across replicas.
    region string
    replication_source_identifier string
    ARN of the source DB cluster or DB instance if this DB cluster is created as a read replica.
    storage_encrypted bool
    Whether the DB cluster is encrypted.
    tags map(string)
    Map of tags assigned to the resource.
    upgrade_rollout_order string
    Order in which minor and major version upgrades are applied to the cluster.
    vpc_security_group_ids list(string)
    VPC security groups the cluster belongs to.
    arn String
    ARN of the cluster.
    availabilityZones List<String>
    Availability Zones of the RDS cluster.
    backtrackWindow Integer
    Target backtrack window, in seconds.
    backupRetentionPeriod Integer
    Days to retain backups for.
    clusterIdentifier String
    clusterMembers List<String>
    List of RDS Instances that are a part of this cluster.
    clusterResourceId String
    RDS Cluster Resource ID.
    clusterScalabilityType String
    Scalability mode of the cluster.
    databaseInsightsMode String
    Mode of Database Insights that is enabled for the cluster.
    databaseName String
    Name for an automatically created database on cluster creation.
    dbClusterParameterGroupName String
    Cluster parameter group associated with the cluster.
    dbSubnetGroupName String
    DB subnet group associated with the cluster.
    dbSystemId String
    System ID of the cluster.
    deletionProtection Boolean
    Whether the cluster has deletion protection enabled.
    enabledCloudwatchLogsExports List<String>
    List of log types exported to CloudWatch Logs.
    endpoint String
    DNS address of the RDS instance.
    engine String
    Database engine.
    engineMode String
    Database engine mode.
    engineVersion String
    Database engine version.
    finalSnapshotIdentifier String
    Name of the final snapshot taken when the cluster is deleted.
    hostedZoneId String
    Route53 Hosted Zone ID of the endpoint.
    iamDatabaseAuthenticationEnabled Boolean
    Whether mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled.
    iamRoles List<String>
    IAM roles associated with the cluster.
    id String
    The provider-assigned unique ID for this managed resource.
    kmsKeyId String
    Amazon Web Services KMS key identifier that is used to encrypt the secret.
    masterUserSecrets List<GetClusterMasterUserSecret>
    Block that specifies the master user secret. Only available when manageMasterUserPassword is set to true. Documented below.
    masterUsername String
    Master username for the database.
    monitoringInterval Integer
    Interval, in seconds, between points when Enhanced Monitoring metrics are collected for the cluster.
    monitoringRoleArn String
    ARN of the IAM role used by RDS to send Enhanced Monitoring metrics to CloudWatch Logs.
    networkType String
    Network type of the cluster.
    port Integer
    Port on which the DB accepts connections.
    preferredBackupWindow String
    Daily time range during which automated backups are created.
    preferredMaintenanceWindow String
    Weekly time range during which system maintenance can occur.
    readerEndpoint String
    Read-only endpoint for the cluster, automatically load-balanced across replicas.
    region String
    replicationSourceIdentifier String
    ARN of the source DB cluster or DB instance if this DB cluster is created as a read replica.
    storageEncrypted Boolean
    Whether the DB cluster is encrypted.
    tags Map<String,String>
    Map of tags assigned to the resource.
    upgradeRolloutOrder String
    Order in which minor and major version upgrades are applied to the cluster.
    vpcSecurityGroupIds List<String>
    VPC security groups the cluster belongs to.
    arn string
    ARN of the cluster.
    availabilityZones string[]
    Availability Zones of the RDS cluster.
    backtrackWindow number
    Target backtrack window, in seconds.
    backupRetentionPeriod number
    Days to retain backups for.
    clusterIdentifier string
    clusterMembers string[]
    List of RDS Instances that are a part of this cluster.
    clusterResourceId string
    RDS Cluster Resource ID.
    clusterScalabilityType string
    Scalability mode of the cluster.
    databaseInsightsMode string
    Mode of Database Insights that is enabled for the cluster.
    databaseName string
    Name for an automatically created database on cluster creation.
    dbClusterParameterGroupName string
    Cluster parameter group associated with the cluster.
    dbSubnetGroupName string
    DB subnet group associated with the cluster.
    dbSystemId string
    System ID of the cluster.
    deletionProtection boolean
    Whether the cluster has deletion protection enabled.
    enabledCloudwatchLogsExports string[]
    List of log types exported to CloudWatch Logs.
    endpoint string
    DNS address of the RDS instance.
    engine string
    Database engine.
    engineMode string
    Database engine mode.
    engineVersion string
    Database engine version.
    finalSnapshotIdentifier string
    Name of the final snapshot taken when the cluster is deleted.
    hostedZoneId string
    Route53 Hosted Zone ID of the endpoint.
    iamDatabaseAuthenticationEnabled boolean
    Whether mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled.
    iamRoles string[]
    IAM roles associated with the cluster.
    id string
    The provider-assigned unique ID for this managed resource.
    kmsKeyId string
    Amazon Web Services KMS key identifier that is used to encrypt the secret.
    masterUserSecrets GetClusterMasterUserSecret[]
    Block that specifies the master user secret. Only available when manageMasterUserPassword is set to true. Documented below.
    masterUsername string
    Master username for the database.
    monitoringInterval number
    Interval, in seconds, between points when Enhanced Monitoring metrics are collected for the cluster.
    monitoringRoleArn string
    ARN of the IAM role used by RDS to send Enhanced Monitoring metrics to CloudWatch Logs.
    networkType string
    Network type of the cluster.
    port number
    Port on which the DB accepts connections.
    preferredBackupWindow string
    Daily time range during which automated backups are created.
    preferredMaintenanceWindow string
    Weekly time range during which system maintenance can occur.
    readerEndpoint string
    Read-only endpoint for the cluster, automatically load-balanced across replicas.
    region string
    replicationSourceIdentifier string
    ARN of the source DB cluster or DB instance if this DB cluster is created as a read replica.
    storageEncrypted boolean
    Whether the DB cluster is encrypted.
    tags {[key: string]: string}
    Map of tags assigned to the resource.
    upgradeRolloutOrder string
    Order in which minor and major version upgrades are applied to the cluster.
    vpcSecurityGroupIds string[]
    VPC security groups the cluster belongs to.
    arn str
    ARN of the cluster.
    availability_zones Sequence[str]
    Availability Zones of the RDS cluster.
    backtrack_window int
    Target backtrack window, in seconds.
    backup_retention_period int
    Days to retain backups for.
    cluster_identifier str
    cluster_members Sequence[str]
    List of RDS Instances that are a part of this cluster.
    cluster_resource_id str
    RDS Cluster Resource ID.
    cluster_scalability_type str
    Scalability mode of the cluster.
    database_insights_mode str
    Mode of Database Insights that is enabled for the cluster.
    database_name str
    Name for an automatically created database on cluster creation.
    db_cluster_parameter_group_name str
    Cluster parameter group associated with the cluster.
    db_subnet_group_name str
    DB subnet group associated with the cluster.
    db_system_id str
    System ID of the cluster.
    deletion_protection bool
    Whether the cluster has deletion protection enabled.
    enabled_cloudwatch_logs_exports Sequence[str]
    List of log types exported to CloudWatch Logs.
    endpoint str
    DNS address of the RDS instance.
    engine str
    Database engine.
    engine_mode str
    Database engine mode.
    engine_version str
    Database engine version.
    final_snapshot_identifier str
    Name of the final snapshot taken when the cluster is deleted.
    hosted_zone_id str
    Route53 Hosted Zone ID of the endpoint.
    iam_database_authentication_enabled bool
    Whether mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled.
    iam_roles Sequence[str]
    IAM roles associated with the cluster.
    id str
    The provider-assigned unique ID for this managed resource.
    kms_key_id str
    Amazon Web Services KMS key identifier that is used to encrypt the secret.
    master_user_secrets Sequence[GetClusterMasterUserSecret]
    Block that specifies the master user secret. Only available when manageMasterUserPassword is set to true. Documented below.
    master_username str
    Master username for the database.
    monitoring_interval int
    Interval, in seconds, between points when Enhanced Monitoring metrics are collected for the cluster.
    monitoring_role_arn str
    ARN of the IAM role used by RDS to send Enhanced Monitoring metrics to CloudWatch Logs.
    network_type str
    Network type of the cluster.
    port int
    Port on which the DB accepts connections.
    preferred_backup_window str
    Daily time range during which automated backups are created.
    preferred_maintenance_window str
    Weekly time range during which system maintenance can occur.
    reader_endpoint str
    Read-only endpoint for the cluster, automatically load-balanced across replicas.
    region str
    replication_source_identifier str
    ARN of the source DB cluster or DB instance if this DB cluster is created as a read replica.
    storage_encrypted bool
    Whether the DB cluster is encrypted.
    tags Mapping[str, str]
    Map of tags assigned to the resource.
    upgrade_rollout_order str
    Order in which minor and major version upgrades are applied to the cluster.
    vpc_security_group_ids Sequence[str]
    VPC security groups the cluster belongs to.
    arn String
    ARN of the cluster.
    availabilityZones List<String>
    Availability Zones of the RDS cluster.
    backtrackWindow Number
    Target backtrack window, in seconds.
    backupRetentionPeriod Number
    Days to retain backups for.
    clusterIdentifier String
    clusterMembers List<String>
    List of RDS Instances that are a part of this cluster.
    clusterResourceId String
    RDS Cluster Resource ID.
    clusterScalabilityType String
    Scalability mode of the cluster.
    databaseInsightsMode String
    Mode of Database Insights that is enabled for the cluster.
    databaseName String
    Name for an automatically created database on cluster creation.
    dbClusterParameterGroupName String
    Cluster parameter group associated with the cluster.
    dbSubnetGroupName String
    DB subnet group associated with the cluster.
    dbSystemId String
    System ID of the cluster.
    deletionProtection Boolean
    Whether the cluster has deletion protection enabled.
    enabledCloudwatchLogsExports List<String>
    List of log types exported to CloudWatch Logs.
    endpoint String
    DNS address of the RDS instance.
    engine String
    Database engine.
    engineMode String
    Database engine mode.
    engineVersion String
    Database engine version.
    finalSnapshotIdentifier String
    Name of the final snapshot taken when the cluster is deleted.
    hostedZoneId String
    Route53 Hosted Zone ID of the endpoint.
    iamDatabaseAuthenticationEnabled Boolean
    Whether mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled.
    iamRoles List<String>
    IAM roles associated with the cluster.
    id String
    The provider-assigned unique ID for this managed resource.
    kmsKeyId String
    Amazon Web Services KMS key identifier that is used to encrypt the secret.
    masterUserSecrets List<Property Map>
    Block that specifies the master user secret. Only available when manageMasterUserPassword is set to true. Documented below.
    masterUsername String
    Master username for the database.
    monitoringInterval Number
    Interval, in seconds, between points when Enhanced Monitoring metrics are collected for the cluster.
    monitoringRoleArn String
    ARN of the IAM role used by RDS to send Enhanced Monitoring metrics to CloudWatch Logs.
    networkType String
    Network type of the cluster.
    port Number
    Port on which the DB accepts connections.
    preferredBackupWindow String
    Daily time range during which automated backups are created.
    preferredMaintenanceWindow String
    Weekly time range during which system maintenance can occur.
    readerEndpoint String
    Read-only endpoint for the cluster, automatically load-balanced across replicas.
    region String
    replicationSourceIdentifier String
    ARN of the source DB cluster or DB instance if this DB cluster is created as a read replica.
    storageEncrypted Boolean
    Whether the DB cluster is encrypted.
    tags Map<String>
    Map of tags assigned to the resource.
    upgradeRolloutOrder String
    Order in which minor and major version upgrades are applied to the cluster.
    vpcSecurityGroupIds List<String>
    VPC security groups the cluster belongs to.

    Supporting Types

    GetClusterMasterUserSecret

    KmsKeyId string
    Amazon Web Services KMS key identifier that is used to encrypt the secret.
    SecretArn string
    ARN of the secret.
    SecretStatus string
    Status of the secret.
    KmsKeyId string
    Amazon Web Services KMS key identifier that is used to encrypt the secret.
    SecretArn string
    ARN of the secret.
    SecretStatus string
    Status of the secret.
    kms_key_id string
    Amazon Web Services KMS key identifier that is used to encrypt the secret.
    secret_arn string
    ARN of the secret.
    secret_status string
    Status of the secret.
    kmsKeyId String
    Amazon Web Services KMS key identifier that is used to encrypt the secret.
    secretArn String
    ARN of the secret.
    secretStatus String
    Status of the secret.
    kmsKeyId string
    Amazon Web Services KMS key identifier that is used to encrypt the secret.
    secretArn string
    ARN of the secret.
    secretStatus string
    Status of the secret.
    kms_key_id str
    Amazon Web Services KMS key identifier that is used to encrypt the secret.
    secret_arn str
    ARN of the secret.
    secret_status str
    Status of the secret.
    kmsKeyId String
    Amazon Web Services KMS key identifier that is used to encrypt the secret.
    secretArn String
    ARN of the secret.
    secretStatus String
    Status of the secret.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo aws logo
    Viewing docs for AWS v7.50.0
    published on Thursday, Oct 8, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-aws

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial