aws-native logo
AWS Native v0.64.0, Jun 2 23

aws-native.neptune.getDBCluster

Explore with Pulumi AI

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>
def get_db_cluster(d_b_cluster_identifier: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetDBClusterResult
def get_db_cluster_output(d_b_cluster_identifier: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetDBClusterResult]
func LookupDBCluster(ctx *Context, args *LookupDBClusterArgs, opts ...InvokeOption) (*LookupDBClusterResult, error)
func LookupDBClusterOutput(ctx *Context, args *LookupDBClusterOutputArgs, opts ...InvokeOption) LookupDBClusterResultOutput

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

public static class GetDBCluster 
{
    public static Task<GetDBClusterResult> InvokeAsync(GetDBClusterArgs args, InvokeOptions? opts = null)
    public static Output<GetDBClusterResult> Invoke(GetDBClusterInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetDBClusterResult> getDBCluster(GetDBClusterArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: aws-native:neptune:getDBCluster
  arguments:
    # arguments dictionary

The following arguments are supported:

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

d_b_cluster_identifier 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 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.DBClusterRole>

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

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.

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

Specifies the port that the database engine is listening on.

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.Neptune.Outputs.DBClusterTag>

The tags assigned to this cluster.

VpcSecurityGroupIds List<string>

Provides a list of VPC security groups that the DB cluster belongs to.

AssociatedRoles []DBClusterRole

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

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.

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

Specifies the port that the database engine is listening on.

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 []DBClusterTag

The tags assigned to this cluster.

VpcSecurityGroupIds []string

Provides a list of VPC security groups that the DB cluster belongs to.

associatedRoles List<DBClusterRole>

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

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.

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

Specifies the port that the database engine is listening on.

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

The tags assigned to this cluster.

vpcSecurityGroupIds List<String>

Provides a list of VPC security groups that the DB cluster belongs to.

associatedRoles DBClusterRole[]

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

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.

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

Specifies the port that the database engine is listening on.

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 DBClusterTag[]

The tags assigned to this cluster.

vpcSecurityGroupIds string[]

Provides a list of VPC security groups that the DB cluster belongs to.

associated_roles Sequence[DBClusterRole]

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

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.

d_b_cluster_parameter_group_name str

Provides the name of the DB cluster parameter group.

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

Specifies the port that the database engine is listening on.

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[DBClusterTag]

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.

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

Specifies the port that the database engine is listening on.

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

DBClusterRole

RoleArn string

The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.

FeatureName string

The name of the feature associated with the AWS Identity and Access Management (IAM) role. For the list of supported feature names, see DBEngineVersion in the Amazon Neptune 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 Neptune 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 Neptune 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 Neptune API Reference.

role_arn str

The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.

feature_name str

The name of the feature associated with the AWS Identity and Access Management (IAM) role. For the list of supported feature names, see DBEngineVersion in the Amazon Neptune 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 Neptune API Reference.

DBClusterServerlessScalingConfiguration

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

DBClusterTag

Key string

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

Value string

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

Key string

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

Value string

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

key String

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

value String

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

key string

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

value string

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

key str

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

value str

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

key String

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

value String

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

Package Details

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