Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. neptune
  5. getDbCluster

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.neptune.getDbCluster

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

The AWS::Neptune::DBCluster resource creates an Amazon Neptune DB cluster.

Using getDbCluster

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

function getDbCluster(args: GetDbClusterArgs, opts?: InvokeOptions): Promise<GetDbClusterResult>
function getDbClusterOutput(args: GetDbClusterOutputArgs, opts?: InvokeOptions): Output<GetDbClusterResult>
Copy
def get_db_cluster(db_cluster_identifier: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetDbClusterResult
def get_db_cluster_output(db_cluster_identifier: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetDbClusterResult]
Copy
func LookupDbCluster(ctx *Context, args *LookupDbClusterArgs, opts ...InvokeOption) (*LookupDbClusterResult, error)
func LookupDbClusterOutput(ctx *Context, args *LookupDbClusterOutputArgs, opts ...InvokeOption) LookupDbClusterResultOutput
Copy

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

public static class GetDbCluster 
{
    public static Task<GetDbClusterResult> InvokeAsync(GetDbClusterArgs args, InvokeOptions? opts = null)
    public static Output<GetDbClusterResult> Invoke(GetDbClusterInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetDbClusterResult> getDbCluster(GetDbClusterArgs args, InvokeOptions options)
public static Output<GetDbClusterResult> getDbCluster(GetDbClusterArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: aws-native:neptune:getDbCluster
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

DbClusterIdentifier This property is required. string
The DB cluster identifier. Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster stored as a lowercase string.
DbClusterIdentifier This property is required. string
The DB cluster identifier. Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster stored as a lowercase string.
dbClusterIdentifier This property is required. String
The DB cluster identifier. Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster stored as a lowercase string.
dbClusterIdentifier This property is required. string
The DB cluster identifier. Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster stored as a lowercase string.
db_cluster_identifier This property is required. str
The DB cluster identifier. Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster stored as a lowercase string.
dbClusterIdentifier This property is required. String
The DB cluster identifier. Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster stored as a lowercase string.

getDbCluster Result

The following output properties are available:

AssociatedRoles List<Pulumi.AwsNative.Neptune.Outputs.DbClusterDbClusterRole>
Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf.
BackupRetentionPeriod int
Specifies the number of days for which automatic DB snapshots are retained.
ClusterResourceId string
The resource id for the DB cluster. For example: cluster-ABCD1234EFGH5678IJKL90MNOP. The cluster ID uniquely identifies the cluster and is used in things like IAM authentication policies.
CopyTagsToSnapshot bool
A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default behaviour is not to copy them.
DbClusterParameterGroupName string
Provides the name of the DB cluster parameter group.
DbPort int

The port number on which the DB instances in the DB cluster accept connections.

If not specified, the default port used is 8182.

Note: Port property will soon be deprecated from this resource. Please update existing templates to rename it with new property DBPort having same functionalities.

DeletionProtection bool
Indicates whether or not the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.
EnableCloudwatchLogsExports List<string>
Specifies a list of log types that are enabled for export to CloudWatch Logs.
Endpoint string
The connection endpoint for the DB cluster. For example: mystack-mydbcluster-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com
EngineVersion string
Indicates the database engine version.
IamAuthEnabled bool
True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
Port string
The port number on which the DB cluster accepts connections. For example: 8182.
PreferredBackupWindow string
Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
PreferredMaintenanceWindow string
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
ReadEndpoint string
The reader endpoint for the DB cluster. For example: mystack-mydbcluster-ro-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com
ServerlessScalingConfiguration Pulumi.AwsNative.Neptune.Outputs.DbClusterServerlessScalingConfiguration
Contains the scaling configuration used by the Neptune Serverless Instances within this DB cluster.
Tags List<Pulumi.AwsNative.Outputs.Tag>
The tags assigned to this cluster.
VpcSecurityGroupIds List<string>
Provides a list of VPC security groups that the DB cluster belongs to.
AssociatedRoles []DbClusterDbClusterRole
Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf.
BackupRetentionPeriod int
Specifies the number of days for which automatic DB snapshots are retained.
ClusterResourceId string
The resource id for the DB cluster. For example: cluster-ABCD1234EFGH5678IJKL90MNOP. The cluster ID uniquely identifies the cluster and is used in things like IAM authentication policies.
CopyTagsToSnapshot bool
A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default behaviour is not to copy them.
DbClusterParameterGroupName string
Provides the name of the DB cluster parameter group.
DbPort int

The port number on which the DB instances in the DB cluster accept connections.

If not specified, the default port used is 8182.

Note: Port property will soon be deprecated from this resource. Please update existing templates to rename it with new property DBPort having same functionalities.

DeletionProtection bool
Indicates whether or not the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.
EnableCloudwatchLogsExports []string
Specifies a list of log types that are enabled for export to CloudWatch Logs.
Endpoint string
The connection endpoint for the DB cluster. For example: mystack-mydbcluster-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com
EngineVersion string
Indicates the database engine version.
IamAuthEnabled bool
True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
Port string
The port number on which the DB cluster accepts connections. For example: 8182.
PreferredBackupWindow string
Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
PreferredMaintenanceWindow string
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
ReadEndpoint string
The reader endpoint for the DB cluster. For example: mystack-mydbcluster-ro-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com
ServerlessScalingConfiguration DbClusterServerlessScalingConfiguration
Contains the scaling configuration used by the Neptune Serverless Instances within this DB cluster.
Tags Tag
The tags assigned to this cluster.
VpcSecurityGroupIds []string
Provides a list of VPC security groups that the DB cluster belongs to.
associatedRoles List<DbClusterDbClusterRole>
Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf.
backupRetentionPeriod Integer
Specifies the number of days for which automatic DB snapshots are retained.
clusterResourceId String
The resource id for the DB cluster. For example: cluster-ABCD1234EFGH5678IJKL90MNOP. The cluster ID uniquely identifies the cluster and is used in things like IAM authentication policies.
copyTagsToSnapshot Boolean
A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default behaviour is not to copy them.
dbClusterParameterGroupName String
Provides the name of the DB cluster parameter group.
dbPort Integer

The port number on which the DB instances in the DB cluster accept connections.

If not specified, the default port used is 8182.

Note: Port property will soon be deprecated from this resource. Please update existing templates to rename it with new property DBPort having same functionalities.

deletionProtection Boolean
Indicates whether or not the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.
enableCloudwatchLogsExports List<String>
Specifies a list of log types that are enabled for export to CloudWatch Logs.
endpoint String
The connection endpoint for the DB cluster. For example: mystack-mydbcluster-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com
engineVersion String
Indicates the database engine version.
iamAuthEnabled Boolean
True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
port String
The port number on which the DB cluster accepts connections. For example: 8182.
preferredBackupWindow String
Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
preferredMaintenanceWindow String
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
readEndpoint String
The reader endpoint for the DB cluster. For example: mystack-mydbcluster-ro-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com
serverlessScalingConfiguration DbClusterServerlessScalingConfiguration
Contains the scaling configuration used by the Neptune Serverless Instances within this DB cluster.
tags List<Tag>
The tags assigned to this cluster.
vpcSecurityGroupIds List<String>
Provides a list of VPC security groups that the DB cluster belongs to.
associatedRoles DbClusterDbClusterRole[]
Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf.
backupRetentionPeriod number
Specifies the number of days for which automatic DB snapshots are retained.
clusterResourceId string
The resource id for the DB cluster. For example: cluster-ABCD1234EFGH5678IJKL90MNOP. The cluster ID uniquely identifies the cluster and is used in things like IAM authentication policies.
copyTagsToSnapshot boolean
A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default behaviour is not to copy them.
dbClusterParameterGroupName string
Provides the name of the DB cluster parameter group.
dbPort number

The port number on which the DB instances in the DB cluster accept connections.

If not specified, the default port used is 8182.

Note: Port property will soon be deprecated from this resource. Please update existing templates to rename it with new property DBPort having same functionalities.

deletionProtection boolean
Indicates whether or not the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.
enableCloudwatchLogsExports string[]
Specifies a list of log types that are enabled for export to CloudWatch Logs.
endpoint string
The connection endpoint for the DB cluster. For example: mystack-mydbcluster-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com
engineVersion string
Indicates the database engine version.
iamAuthEnabled boolean
True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
port string
The port number on which the DB cluster accepts connections. For example: 8182.
preferredBackupWindow string
Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
preferredMaintenanceWindow string
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
readEndpoint string
The reader endpoint for the DB cluster. For example: mystack-mydbcluster-ro-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com
serverlessScalingConfiguration DbClusterServerlessScalingConfiguration
Contains the scaling configuration used by the Neptune Serverless Instances within this DB cluster.
tags Tag[]
The tags assigned to this cluster.
vpcSecurityGroupIds string[]
Provides a list of VPC security groups that the DB cluster belongs to.
associated_roles Sequence[DbClusterDbClusterRole]
Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf.
backup_retention_period int
Specifies the number of days for which automatic DB snapshots are retained.
cluster_resource_id str
The resource id for the DB cluster. For example: cluster-ABCD1234EFGH5678IJKL90MNOP. The cluster ID uniquely identifies the cluster and is used in things like IAM authentication policies.
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 behaviour is not to copy them.
db_cluster_parameter_group_name str
Provides the name of the DB cluster parameter group.
db_port int

The port number on which the DB instances in the DB cluster accept connections.

If not specified, the default port used is 8182.

Note: Port property will soon be deprecated from this resource. Please update existing templates to rename it with new property DBPort having same functionalities.

deletion_protection bool
Indicates whether or not the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.
enable_cloudwatch_logs_exports Sequence[str]
Specifies a list of log types that are enabled for export to CloudWatch Logs.
endpoint str
The connection endpoint for the DB cluster. For example: mystack-mydbcluster-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com
engine_version str
Indicates the database engine version.
iam_auth_enabled bool
True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
port str
The port number on which the DB cluster accepts connections. For example: 8182.
preferred_backup_window str
Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
preferred_maintenance_window str
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
read_endpoint str
The reader endpoint for the DB cluster. For example: mystack-mydbcluster-ro-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com
serverless_scaling_configuration DbClusterServerlessScalingConfiguration
Contains the scaling configuration used by the Neptune Serverless Instances within this DB cluster.
tags Sequence[root_Tag]
The tags assigned to this cluster.
vpc_security_group_ids Sequence[str]
Provides a list of VPC security groups that the DB cluster belongs to.
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.
backupRetentionPeriod Number
Specifies the number of days for which automatic DB snapshots are retained.
clusterResourceId String
The resource id for the DB cluster. For example: cluster-ABCD1234EFGH5678IJKL90MNOP. The cluster ID uniquely identifies the cluster and is used in things like IAM authentication policies.
copyTagsToSnapshot Boolean
A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default behaviour is not to copy them.
dbClusterParameterGroupName String
Provides the name of the DB cluster parameter group.
dbPort Number

The port number on which the DB instances in the DB cluster accept connections.

If not specified, the default port used is 8182.

Note: Port property will soon be deprecated from this resource. Please update existing templates to rename it with new property DBPort having same functionalities.

deletionProtection Boolean
Indicates whether or not the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.
enableCloudwatchLogsExports List<String>
Specifies a list of log types that are enabled for export to CloudWatch Logs.
endpoint String
The connection endpoint for the DB cluster. For example: mystack-mydbcluster-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com
engineVersion String
Indicates the database engine version.
iamAuthEnabled Boolean
True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
port String
The port number on which the DB cluster accepts connections. For example: 8182.
preferredBackupWindow String
Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
preferredMaintenanceWindow String
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
readEndpoint String
The reader endpoint for the DB cluster. For example: mystack-mydbcluster-ro-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com
serverlessScalingConfiguration Property Map
Contains the scaling configuration used by the Neptune Serverless Instances within this DB cluster.
tags List<Property Map>
The tags assigned to this cluster.
vpcSecurityGroupIds List<String>
Provides a list of VPC security groups that the DB cluster belongs to.

Supporting Types

DbClusterDbClusterRole

RoleArn This property is required. 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 Neptune API Reference.
RoleArn This property is required. 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 Neptune API Reference.
roleArn This property is required. 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 Neptune API Reference.
roleArn This property is required. 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 Neptune API Reference.
role_arn This property is required. str
The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.
feature_name str
The name of the feature associated with the AWS Identity and Access Management (IAM) role. For the list of supported feature names, see DBEngineVersion in the Amazon Neptune API Reference.
roleArn This property is required. 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 Neptune API Reference.

DbClusterServerlessScalingConfiguration

MaxCapacity This property is required. double
The maximum number of Neptune capacity units (NCUs) for a DB instance in an Neptune Serverless cluster. You can specify NCU values in half-step increments, such as 40, 40.5, 41, and so on. The smallest value you can use is 2.5, whereas the largest is 128.
MinCapacity This property is required. double
The minimum number of Neptune capacity units (NCUs) for a DB instance in an Neptune Serverless cluster. You can specify NCU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value you can use is 1, whereas the largest is 128.
MaxCapacity This property is required. float64
The maximum number of Neptune capacity units (NCUs) for a DB instance in an Neptune Serverless cluster. You can specify NCU values in half-step increments, such as 40, 40.5, 41, and so on. The smallest value you can use is 2.5, whereas the largest is 128.
MinCapacity This property is required. float64
The minimum number of Neptune capacity units (NCUs) for a DB instance in an Neptune Serverless cluster. You can specify NCU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value you can use is 1, whereas the largest is 128.
maxCapacity This property is required. Double
The maximum number of Neptune capacity units (NCUs) for a DB instance in an Neptune Serverless cluster. You can specify NCU values in half-step increments, such as 40, 40.5, 41, and so on. The smallest value you can use is 2.5, whereas the largest is 128.
minCapacity This property is required. Double
The minimum number of Neptune capacity units (NCUs) for a DB instance in an Neptune Serverless cluster. You can specify NCU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value you can use is 1, whereas the largest is 128.
maxCapacity This property is required. number
The maximum number of Neptune capacity units (NCUs) for a DB instance in an Neptune Serverless cluster. You can specify NCU values in half-step increments, such as 40, 40.5, 41, and so on. The smallest value you can use is 2.5, whereas the largest is 128.
minCapacity This property is required. number
The minimum number of Neptune capacity units (NCUs) for a DB instance in an Neptune Serverless cluster. You can specify NCU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value you can use is 1, whereas the largest is 128.
max_capacity This property is required. float
The maximum number of Neptune capacity units (NCUs) for a DB instance in an Neptune Serverless cluster. You can specify NCU values in half-step increments, such as 40, 40.5, 41, and so on. The smallest value you can use is 2.5, whereas the largest is 128.
min_capacity This property is required. float
The minimum number of Neptune capacity units (NCUs) for a DB instance in an Neptune Serverless cluster. You can specify NCU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value you can use is 1, whereas the largest is 128.
maxCapacity This property is required. Number
The maximum number of Neptune capacity units (NCUs) for a DB instance in an Neptune Serverless cluster. You can specify NCU values in half-step increments, such as 40, 40.5, 41, and so on. The smallest value you can use is 2.5, whereas the largest is 128.
minCapacity This property is required. Number
The minimum number of Neptune capacity units (NCUs) for a DB instance in an Neptune Serverless cluster. You can specify NCU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value you can use is 1, whereas the largest is 128.

Tag

Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag
key This property is required. string
The key name of the tag
value This property is required. string
The value of the tag
key This property is required. str
The key name of the tag
value This property is required. str
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag

Package Details

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

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native