neptune

package
v0.106.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 20, 2024 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type DbCluster added in v0.72.0 

type DbCluster struct {
	pulumi.CustomResourceState

	// 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.
	AssociatedRoles DbClusterDbClusterRoleArrayOutput `pulumi:"associatedRoles"`
	// Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.
	AvailabilityZones pulumi.StringArrayOutput `pulumi:"availabilityZones"`
	// Specifies the number of days for which automatic DB snapshots are retained.
	BackupRetentionPeriod pulumi.IntPtrOutput `pulumi:"backupRetentionPeriod"`
	// 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.
	ClusterResourceId pulumi.StringOutput `pulumi:"clusterResourceId"`
	// 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.
	CopyTagsToSnapshot pulumi.BoolPtrOutput `pulumi:"copyTagsToSnapshot"`
	// 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 pulumi.StringPtrOutput `pulumi:"dbClusterIdentifier"`
	// Provides the name of the DB cluster parameter group.
	DbClusterParameterGroupName pulumi.StringPtrOutput `pulumi:"dbClusterParameterGroupName"`
	// The name of the DB parameter group to apply to all instances of the DB cluster. Used only in case of a major EngineVersion upgrade request.
	DbInstanceParameterGroupName pulumi.StringPtrOutput `pulumi:"dbInstanceParameterGroupName"`
	// 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.
	DbPort pulumi.IntPtrOutput `pulumi:"dbPort"`
	// Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
	DbSubnetGroupName pulumi.StringPtrOutput `pulumi:"dbSubnetGroupName"`
	// Indicates whether or not the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.
	DeletionProtection pulumi.BoolPtrOutput `pulumi:"deletionProtection"`
	// Specifies a list of log types that are enabled for export to CloudWatch Logs.
	EnableCloudwatchLogsExports pulumi.StringArrayOutput `pulumi:"enableCloudwatchLogsExports"`
	// The connection endpoint for the DB cluster. For example: `mystack-mydbcluster-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com`
	Endpoint pulumi.StringOutput `pulumi:"endpoint"`
	// Indicates the database engine version.
	EngineVersion pulumi.StringPtrOutput `pulumi:"engineVersion"`
	// True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
	IamAuthEnabled pulumi.BoolPtrOutput `pulumi:"iamAuthEnabled"`
	// If `StorageEncrypted` is true, the Amazon KMS key identifier for the encrypted DB cluster.
	KmsKeyId pulumi.StringPtrOutput `pulumi:"kmsKeyId"`
	// The port number on which the DB cluster accepts connections. For example: `8182`.
	Port pulumi.StringOutput `pulumi:"port"`
	// Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
	PreferredBackupWindow pulumi.StringPtrOutput `pulumi:"preferredBackupWindow"`
	// Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
	PreferredMaintenanceWindow pulumi.StringPtrOutput `pulumi:"preferredMaintenanceWindow"`
	// The reader endpoint for the DB cluster. For example: `mystack-mydbcluster-ro-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com`
	ReadEndpoint pulumi.StringOutput `pulumi:"readEndpoint"`
	// Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
	//
	// If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.
	//
	// If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.
	RestoreToTime pulumi.StringPtrOutput `pulumi:"restoreToTime"`
	// Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
	//
	// If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.
	//
	// If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.
	RestoreType pulumi.StringPtrOutput `pulumi:"restoreType"`
	// Contains the scaling configuration used by the Neptune Serverless Instances within this DB cluster.
	ServerlessScalingConfiguration DbClusterServerlessScalingConfigurationPtrOutput `pulumi:"serverlessScalingConfiguration"`
	// Specifies the identifier for a DB cluster snapshot. Must match the identifier of an existing snapshot.
	//
	// After you restore a DB cluster using a SnapshotIdentifier, you must specify the same SnapshotIdentifier 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, 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 snapshot specified by the SnapshotIdentifier, and the original DB cluster is deleted.
	SnapshotIdentifier pulumi.StringPtrOutput `pulumi:"snapshotIdentifier"`
	// Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
	//
	// If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.
	//
	// If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.
	SourceDbClusterIdentifier pulumi.StringPtrOutput `pulumi:"sourceDbClusterIdentifier"`
	// Indicates whether the DB cluster is encrypted.
	//
	// If you specify the `DBClusterIdentifier`, `DBSnapshotIdentifier`, or `SourceDBInstanceIdentifier` property, don't specify this property. The value is inherited from the cluster, snapshot, or source DB instance. If you specify the KmsKeyId property, you must enable encryption.
	//
	// If you specify the KmsKeyId, you must enable encryption by setting StorageEncrypted to true.
	StorageEncrypted pulumi.BoolPtrOutput `pulumi:"storageEncrypted"`
	// The tags assigned to this cluster.
	Tags aws.TagArrayOutput `pulumi:"tags"`
	// Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
	//
	// If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.
	//
	// If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.
	UseLatestRestorableTime pulumi.BoolPtrOutput `pulumi:"useLatestRestorableTime"`
	// Provides a list of VPC security groups that the DB cluster belongs to.
	VpcSecurityGroupIds pulumi.StringArrayOutput `pulumi:"vpcSecurityGroupIds"`
}

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

func GetDbCluster added in v0.72.0 

func GetDbCluster(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *DbClusterState, opts ...pulumi.ResourceOption) (*DbCluster, error)

GetDbCluster gets an existing DbCluster resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewDbCluster added in v0.72.0 

func NewDbCluster(ctx *pulumi.Context,
	name string, args *DbClusterArgs, opts ...pulumi.ResourceOption) (*DbCluster, error)

NewDbCluster registers a new resource with the given unique name, arguments, and options.

func (*DbCluster) ElementType added in v0.72.0 

func (*DbCluster) ElementType() reflect.Type

func (*DbCluster) ToDbClusterOutput added in v0.72.0 

func (i *DbCluster) ToDbClusterOutput() DbClusterOutput

func (*DbCluster) ToDbClusterOutputWithContext added in v0.72.0 

func (i *DbCluster) ToDbClusterOutputWithContext(ctx context.Context) DbClusterOutput

type DbClusterArgs added in v0.72.0 

type DbClusterArgs struct {
	// 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.
	AssociatedRoles DbClusterDbClusterRoleArrayInput
	// Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.
	AvailabilityZones pulumi.StringArrayInput
	// Specifies the number of days for which automatic DB snapshots are retained.
	BackupRetentionPeriod pulumi.IntPtrInput
	// 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.
	CopyTagsToSnapshot pulumi.BoolPtrInput
	// 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 pulumi.StringPtrInput
	// Provides the name of the DB cluster parameter group.
	DbClusterParameterGroupName pulumi.StringPtrInput
	// The name of the DB parameter group to apply to all instances of the DB cluster. Used only in case of a major EngineVersion upgrade request.
	DbInstanceParameterGroupName pulumi.StringPtrInput
	// 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.
	DbPort pulumi.IntPtrInput
	// Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
	DbSubnetGroupName pulumi.StringPtrInput
	// Indicates whether or not the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.
	DeletionProtection pulumi.BoolPtrInput
	// Specifies a list of log types that are enabled for export to CloudWatch Logs.
	EnableCloudwatchLogsExports pulumi.StringArrayInput
	// Indicates the database engine version.
	EngineVersion pulumi.StringPtrInput
	// True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
	IamAuthEnabled pulumi.BoolPtrInput
	// If `StorageEncrypted` is true, the Amazon KMS key identifier for the encrypted DB cluster.
	KmsKeyId pulumi.StringPtrInput
	// Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
	PreferredBackupWindow pulumi.StringPtrInput
	// Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
	PreferredMaintenanceWindow pulumi.StringPtrInput
	// Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
	//
	// If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.
	//
	// If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.
	RestoreToTime pulumi.StringPtrInput
	// Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
	//
	// If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.
	//
	// If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.
	RestoreType pulumi.StringPtrInput
	// Contains the scaling configuration used by the Neptune Serverless Instances within this DB cluster.
	ServerlessScalingConfiguration DbClusterServerlessScalingConfigurationPtrInput
	// Specifies the identifier for a DB cluster snapshot. Must match the identifier of an existing snapshot.
	//
	// After you restore a DB cluster using a SnapshotIdentifier, you must specify the same SnapshotIdentifier 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, 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 snapshot specified by the SnapshotIdentifier, and the original DB cluster is deleted.
	SnapshotIdentifier pulumi.StringPtrInput
	// Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
	//
	// If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.
	//
	// If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.
	SourceDbClusterIdentifier pulumi.StringPtrInput
	// Indicates whether the DB cluster is encrypted.
	//
	// If you specify the `DBClusterIdentifier`, `DBSnapshotIdentifier`, or `SourceDBInstanceIdentifier` property, don't specify this property. The value is inherited from the cluster, snapshot, or source DB instance. If you specify the KmsKeyId property, you must enable encryption.
	//
	// If you specify the KmsKeyId, you must enable encryption by setting StorageEncrypted to true.
	StorageEncrypted pulumi.BoolPtrInput
	// The tags assigned to this cluster.
	Tags aws.TagArrayInput
	// Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
	//
	// If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.
	//
	// If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.
	UseLatestRestorableTime pulumi.BoolPtrInput
	// Provides a list of VPC security groups that the DB cluster belongs to.
	VpcSecurityGroupIds pulumi.StringArrayInput
}

The set of arguments for constructing a DbCluster resource.

func (DbClusterArgs) ElementType added in v0.72.0 

func (DbClusterArgs) ElementType() reflect.Type

type DbClusterDbClusterRole added in v0.72.0 

type DbClusterDbClusterRole struct {
	// 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.
	FeatureName *string `pulumi:"featureName"`
	// The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.
	RoleArn string `pulumi:"roleArn"`
}

Describes an AWS Identity and Access Management (IAM) role that is associated with a DB cluster.

type DbClusterDbClusterRoleArgs added in v0.72.0 

type DbClusterDbClusterRoleArgs struct {
	// 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.
	FeatureName pulumi.StringPtrInput `pulumi:"featureName"`
	// The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.
	RoleArn pulumi.StringInput `pulumi:"roleArn"`
}

Describes an AWS Identity and Access Management (IAM) role that is associated with a DB cluster.

func (DbClusterDbClusterRoleArgs) ElementType added in v0.72.0 

func (DbClusterDbClusterRoleArgs) ElementType() reflect.Type

func (DbClusterDbClusterRoleArgs) ToDbClusterDbClusterRoleOutput added in v0.72.0 

func (i DbClusterDbClusterRoleArgs) ToDbClusterDbClusterRoleOutput() DbClusterDbClusterRoleOutput

func (DbClusterDbClusterRoleArgs) ToDbClusterDbClusterRoleOutputWithContext added in v0.72.0 

func (i DbClusterDbClusterRoleArgs) ToDbClusterDbClusterRoleOutputWithContext(ctx context.Context) DbClusterDbClusterRoleOutput

type DbClusterDbClusterRoleArray added in v0.72.0 

type DbClusterDbClusterRoleArray []DbClusterDbClusterRoleInput

func (DbClusterDbClusterRoleArray) ElementType added in v0.72.0 

func (DbClusterDbClusterRoleArray) ElementType() reflect.Type

func (DbClusterDbClusterRoleArray) ToDbClusterDbClusterRoleArrayOutput added in v0.72.0 

func (i DbClusterDbClusterRoleArray) ToDbClusterDbClusterRoleArrayOutput() DbClusterDbClusterRoleArrayOutput

func (DbClusterDbClusterRoleArray) ToDbClusterDbClusterRoleArrayOutputWithContext added in v0.72.0 

func (i DbClusterDbClusterRoleArray) ToDbClusterDbClusterRoleArrayOutputWithContext(ctx context.Context) DbClusterDbClusterRoleArrayOutput

type DbClusterDbClusterRoleArrayInput added in v0.72.0 

type DbClusterDbClusterRoleArrayInput interface {
	pulumi.Input

	ToDbClusterDbClusterRoleArrayOutput() DbClusterDbClusterRoleArrayOutput
	ToDbClusterDbClusterRoleArrayOutputWithContext(context.Context) DbClusterDbClusterRoleArrayOutput
}

DbClusterDbClusterRoleArrayInput is an input type that accepts DbClusterDbClusterRoleArray and DbClusterDbClusterRoleArrayOutput values. You can construct a concrete instance of `DbClusterDbClusterRoleArrayInput` via: 

DbClusterDbClusterRoleArray{ DbClusterDbClusterRoleArgs{...} }

type DbClusterDbClusterRoleArrayOutput added in v0.72.0 

type DbClusterDbClusterRoleArrayOutput struct{ *pulumi.OutputState }

func (DbClusterDbClusterRoleArrayOutput) ElementType added in v0.72.0 

func (DbClusterDbClusterRoleArrayOutput) ElementType() reflect.Type

func (DbClusterDbClusterRoleArrayOutput) Index added in v0.72.0 

func (o DbClusterDbClusterRoleArrayOutput) Index(i pulumi.IntInput) DbClusterDbClusterRoleOutput

func (DbClusterDbClusterRoleArrayOutput) ToDbClusterDbClusterRoleArrayOutput added in v0.72.0 

func (o DbClusterDbClusterRoleArrayOutput) ToDbClusterDbClusterRoleArrayOutput() DbClusterDbClusterRoleArrayOutput

func (DbClusterDbClusterRoleArrayOutput) ToDbClusterDbClusterRoleArrayOutputWithContext added in v0.72.0 

func (o DbClusterDbClusterRoleArrayOutput) ToDbClusterDbClusterRoleArrayOutputWithContext(ctx context.Context) DbClusterDbClusterRoleArrayOutput

type DbClusterDbClusterRoleInput added in v0.72.0 

type DbClusterDbClusterRoleInput interface {
	pulumi.Input

	ToDbClusterDbClusterRoleOutput() DbClusterDbClusterRoleOutput
	ToDbClusterDbClusterRoleOutputWithContext(context.Context) DbClusterDbClusterRoleOutput
}

DbClusterDbClusterRoleInput is an input type that accepts DbClusterDbClusterRoleArgs and DbClusterDbClusterRoleOutput values. You can construct a concrete instance of `DbClusterDbClusterRoleInput` via: 

DbClusterDbClusterRoleArgs{...}

type DbClusterDbClusterRoleOutput added in v0.72.0 

type DbClusterDbClusterRoleOutput struct{ *pulumi.OutputState }

Describes an AWS Identity and Access Management (IAM) role that is associated with a DB cluster.

func (DbClusterDbClusterRoleOutput) ElementType added in v0.72.0 

func (DbClusterDbClusterRoleOutput) ElementType() reflect.Type

func (DbClusterDbClusterRoleOutput) FeatureName added in v0.72.0 

func (o DbClusterDbClusterRoleOutput) FeatureName() pulumi.StringPtrOutput

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.

func (DbClusterDbClusterRoleOutput) RoleArn added in v0.72.0 

func (o DbClusterDbClusterRoleOutput) RoleArn() pulumi.StringOutput

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

func (DbClusterDbClusterRoleOutput) ToDbClusterDbClusterRoleOutput added in v0.72.0 

func (o DbClusterDbClusterRoleOutput) ToDbClusterDbClusterRoleOutput() DbClusterDbClusterRoleOutput

func (DbClusterDbClusterRoleOutput) ToDbClusterDbClusterRoleOutputWithContext added in v0.72.0 

func (o DbClusterDbClusterRoleOutput) ToDbClusterDbClusterRoleOutputWithContext(ctx context.Context) DbClusterDbClusterRoleOutput

type DbClusterInput added in v0.72.0 

type DbClusterInput interface {
	pulumi.Input

	ToDbClusterOutput() DbClusterOutput
	ToDbClusterOutputWithContext(ctx context.Context) DbClusterOutput
}

type DbClusterOutput added in v0.72.0 

type DbClusterOutput struct{ *pulumi.OutputState }

func (DbClusterOutput) AssociatedRoles added in v0.72.0 

func (o DbClusterOutput) AssociatedRoles() DbClusterDbClusterRoleArrayOutput

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.

func (DbClusterOutput) AvailabilityZones added in v0.72.0 

func (o DbClusterOutput) AvailabilityZones() pulumi.StringArrayOutput

Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.

func (DbClusterOutput) BackupRetentionPeriod added in v0.72.0 

func (o DbClusterOutput) BackupRetentionPeriod() pulumi.IntPtrOutput

Specifies the number of days for which automatic DB snapshots are retained.

func (DbClusterOutput) ClusterResourceId added in v0.72.0 

func (o DbClusterOutput) ClusterResourceId() pulumi.StringOutput

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.

func (DbClusterOutput) CopyTagsToSnapshot added in v0.72.0 

func (o DbClusterOutput) CopyTagsToSnapshot() pulumi.BoolPtrOutput

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.

func (DbClusterOutput) DbClusterIdentifier added in v0.72.0 

func (o DbClusterOutput) DbClusterIdentifier() pulumi.StringPtrOutput

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.

func (DbClusterOutput) DbClusterParameterGroupName added in v0.72.0 

func (o DbClusterOutput) DbClusterParameterGroupName() pulumi.StringPtrOutput

Provides the name of the DB cluster parameter group.

func (DbClusterOutput) DbInstanceParameterGroupName added in v0.72.0 

func (o DbClusterOutput) DbInstanceParameterGroupName() pulumi.StringPtrOutput

The name of the DB parameter group to apply to all instances of the DB cluster. Used only in case of a major EngineVersion upgrade request.

func (DbClusterOutput) DbPort added in v0.73.0 

func (o DbClusterOutput) DbPort() pulumi.IntPtrOutput

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.

func (DbClusterOutput) DbSubnetGroupName added in v0.72.0 

func (o DbClusterOutput) DbSubnetGroupName() pulumi.StringPtrOutput

Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.

func (DbClusterOutput) DeletionProtection added in v0.72.0 

func (o DbClusterOutput) DeletionProtection() pulumi.BoolPtrOutput

Indicates whether or not the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.

func (DbClusterOutput) ElementType added in v0.72.0 

func (DbClusterOutput) ElementType() reflect.Type

func (DbClusterOutput) EnableCloudwatchLogsExports added in v0.72.0 

func (o DbClusterOutput) EnableCloudwatchLogsExports() pulumi.StringArrayOutput

Specifies a list of log types that are enabled for export to CloudWatch Logs.

func (DbClusterOutput) Endpoint added in v0.72.0 

func (o DbClusterOutput) Endpoint() pulumi.StringOutput

The connection endpoint for the DB cluster. For example: `mystack-mydbcluster-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com`

func (DbClusterOutput) EngineVersion added in v0.72.0 

func (o DbClusterOutput) EngineVersion() pulumi.StringPtrOutput

Indicates the database engine version.

func (DbClusterOutput) IamAuthEnabled added in v0.72.0 

func (o DbClusterOutput) IamAuthEnabled() pulumi.BoolPtrOutput

True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

func (DbClusterOutput) KmsKeyId added in v0.72.0 

func (o DbClusterOutput) KmsKeyId() pulumi.StringPtrOutput

If `StorageEncrypted` is true, the Amazon KMS key identifier for the encrypted DB cluster.

func (DbClusterOutput) Port added in v0.72.0 

func (o DbClusterOutput) Port() pulumi.StringOutput

The port number on which the DB cluster accepts connections. For example: `8182`.

func (DbClusterOutput) PreferredBackupWindow added in v0.72.0 

func (o DbClusterOutput) PreferredBackupWindow() pulumi.StringPtrOutput

Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

func (DbClusterOutput) PreferredMaintenanceWindow added in v0.72.0 

func (o DbClusterOutput) PreferredMaintenanceWindow() pulumi.StringPtrOutput

Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

func (DbClusterOutput) ReadEndpoint added in v0.72.0 

func (o DbClusterOutput) ReadEndpoint() pulumi.StringOutput

The reader endpoint for the DB cluster. For example: `mystack-mydbcluster-ro-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com`

func (DbClusterOutput) RestoreToTime added in v0.72.0 

func (o DbClusterOutput) RestoreToTime() pulumi.StringPtrOutput

Creates a new DB cluster from a DB snapshot or DB cluster snapshot.

If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.

If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.

func (DbClusterOutput) RestoreType added in v0.72.0 

func (o DbClusterOutput) RestoreType() pulumi.StringPtrOutput

Creates a new DB cluster from a DB snapshot or DB cluster snapshot.

If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.

If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.

func (DbClusterOutput) ServerlessScalingConfiguration added in v0.72.0 

func (o DbClusterOutput) ServerlessScalingConfiguration() DbClusterServerlessScalingConfigurationPtrOutput

Contains the scaling configuration used by the Neptune Serverless Instances within this DB cluster.

func (DbClusterOutput) SnapshotIdentifier added in v0.72.0 

func (o DbClusterOutput) SnapshotIdentifier() pulumi.StringPtrOutput

Specifies the identifier for a DB cluster snapshot. Must match the identifier of an existing snapshot.

After you restore a DB cluster using a SnapshotIdentifier, you must specify the same SnapshotIdentifier 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, 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 snapshot specified by the SnapshotIdentifier, and the original DB cluster is deleted.

func (DbClusterOutput) SourceDbClusterIdentifier added in v0.72.0 

func (o DbClusterOutput) SourceDbClusterIdentifier() pulumi.StringPtrOutput

Creates a new DB cluster from a DB snapshot or DB cluster snapshot.

If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.

If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.

func (DbClusterOutput) StorageEncrypted added in v0.72.0 

func (o DbClusterOutput) StorageEncrypted() pulumi.BoolPtrOutput

Indicates whether the DB cluster is encrypted.

If you specify the `DBClusterIdentifier`, `DBSnapshotIdentifier`, or `SourceDBInstanceIdentifier` property, don't specify this property. The value is inherited from the cluster, snapshot, or source DB instance. If you specify the KmsKeyId property, you must enable encryption.

If you specify the KmsKeyId, you must enable encryption by setting StorageEncrypted to true.

func (DbClusterOutput) Tags added in v0.72.0 

func (o DbClusterOutput) Tags() aws.TagArrayOutput

The tags assigned to this cluster.

func (DbClusterOutput) ToDbClusterOutput added in v0.72.0 

func (o DbClusterOutput) ToDbClusterOutput() DbClusterOutput

func (DbClusterOutput) ToDbClusterOutputWithContext added in v0.72.0 

func (o DbClusterOutput) ToDbClusterOutputWithContext(ctx context.Context) DbClusterOutput

func (DbClusterOutput) UseLatestRestorableTime added in v0.72.0 

func (o DbClusterOutput) UseLatestRestorableTime() pulumi.BoolPtrOutput

Creates a new DB cluster from a DB snapshot or DB cluster snapshot.

If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.

If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.

func (DbClusterOutput) VpcSecurityGroupIds added in v0.72.0 

func (o DbClusterOutput) VpcSecurityGroupIds() pulumi.StringArrayOutput

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

type DbClusterServerlessScalingConfiguration added in v0.72.0 

type DbClusterServerlessScalingConfiguration struct {
	// 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.
	MaxCapacity float64 `pulumi:"maxCapacity"`
	// 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.
	MinCapacity float64 `pulumi:"minCapacity"`
}

Contains the scaling configuration of an Neptune Serverless DB cluster.

type DbClusterServerlessScalingConfigurationArgs added in v0.72.0 

type DbClusterServerlessScalingConfigurationArgs struct {
	// 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.
	MaxCapacity pulumi.Float64Input `pulumi:"maxCapacity"`
	// 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.
	MinCapacity pulumi.Float64Input `pulumi:"minCapacity"`
}

Contains the scaling configuration of an Neptune Serverless DB cluster.

func (DbClusterServerlessScalingConfigurationArgs) ElementType added in v0.72.0 

func (DbClusterServerlessScalingConfigurationArgs) ElementType() reflect.Type

func (DbClusterServerlessScalingConfigurationArgs) ToDbClusterServerlessScalingConfigurationOutput added in v0.72.0 

func (i DbClusterServerlessScalingConfigurationArgs) ToDbClusterServerlessScalingConfigurationOutput() DbClusterServerlessScalingConfigurationOutput

func (DbClusterServerlessScalingConfigurationArgs) ToDbClusterServerlessScalingConfigurationOutputWithContext added in v0.72.0 

func (i DbClusterServerlessScalingConfigurationArgs) ToDbClusterServerlessScalingConfigurationOutputWithContext(ctx context.Context) DbClusterServerlessScalingConfigurationOutput

func (DbClusterServerlessScalingConfigurationArgs) ToDbClusterServerlessScalingConfigurationPtrOutput added in v0.72.0 

func (i DbClusterServerlessScalingConfigurationArgs) ToDbClusterServerlessScalingConfigurationPtrOutput() DbClusterServerlessScalingConfigurationPtrOutput

func (DbClusterServerlessScalingConfigurationArgs) ToDbClusterServerlessScalingConfigurationPtrOutputWithContext added in v0.72.0 

func (i DbClusterServerlessScalingConfigurationArgs) ToDbClusterServerlessScalingConfigurationPtrOutputWithContext(ctx context.Context) DbClusterServerlessScalingConfigurationPtrOutput

type DbClusterServerlessScalingConfigurationInput added in v0.72.0 

type DbClusterServerlessScalingConfigurationInput interface {
	pulumi.Input

	ToDbClusterServerlessScalingConfigurationOutput() DbClusterServerlessScalingConfigurationOutput
	ToDbClusterServerlessScalingConfigurationOutputWithContext(context.Context) DbClusterServerlessScalingConfigurationOutput
}

DbClusterServerlessScalingConfigurationInput is an input type that accepts DbClusterServerlessScalingConfigurationArgs and DbClusterServerlessScalingConfigurationOutput values. You can construct a concrete instance of `DbClusterServerlessScalingConfigurationInput` via: 

DbClusterServerlessScalingConfigurationArgs{...}

type DbClusterServerlessScalingConfigurationOutput added in v0.72.0 

type DbClusterServerlessScalingConfigurationOutput struct{ *pulumi.OutputState }

Contains the scaling configuration of an Neptune Serverless DB cluster.

func (DbClusterServerlessScalingConfigurationOutput) ElementType added in v0.72.0 

func (DbClusterServerlessScalingConfigurationOutput) ElementType() reflect.Type

func (DbClusterServerlessScalingConfigurationOutput) MaxCapacity added in v0.72.0 

func (o DbClusterServerlessScalingConfigurationOutput) MaxCapacity() pulumi.Float64Output

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.

func (DbClusterServerlessScalingConfigurationOutput) MinCapacity added in v0.72.0 

func (o DbClusterServerlessScalingConfigurationOutput) MinCapacity() pulumi.Float64Output

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.

func (DbClusterServerlessScalingConfigurationOutput) ToDbClusterServerlessScalingConfigurationOutput added in v0.72.0 

func (o DbClusterServerlessScalingConfigurationOutput) ToDbClusterServerlessScalingConfigurationOutput() DbClusterServerlessScalingConfigurationOutput

func (DbClusterServerlessScalingConfigurationOutput) ToDbClusterServerlessScalingConfigurationOutputWithContext added in v0.72.0 

func (o DbClusterServerlessScalingConfigurationOutput) ToDbClusterServerlessScalingConfigurationOutputWithContext(ctx context.Context) DbClusterServerlessScalingConfigurationOutput

func (DbClusterServerlessScalingConfigurationOutput) ToDbClusterServerlessScalingConfigurationPtrOutput added in v0.72.0 

func (o DbClusterServerlessScalingConfigurationOutput) ToDbClusterServerlessScalingConfigurationPtrOutput() DbClusterServerlessScalingConfigurationPtrOutput

func (DbClusterServerlessScalingConfigurationOutput) ToDbClusterServerlessScalingConfigurationPtrOutputWithContext added in v0.72.0 

func (o DbClusterServerlessScalingConfigurationOutput) ToDbClusterServerlessScalingConfigurationPtrOutputWithContext(ctx context.Context) DbClusterServerlessScalingConfigurationPtrOutput

type DbClusterServerlessScalingConfigurationPtrInput added in v0.72.0 

type DbClusterServerlessScalingConfigurationPtrInput interface {
	pulumi.Input

	ToDbClusterServerlessScalingConfigurationPtrOutput() DbClusterServerlessScalingConfigurationPtrOutput
	ToDbClusterServerlessScalingConfigurationPtrOutputWithContext(context.Context) DbClusterServerlessScalingConfigurationPtrOutput
}

DbClusterServerlessScalingConfigurationPtrInput is an input type that accepts DbClusterServerlessScalingConfigurationArgs, DbClusterServerlessScalingConfigurationPtr and DbClusterServerlessScalingConfigurationPtrOutput values. You can construct a concrete instance of `DbClusterServerlessScalingConfigurationPtrInput` via: 

        DbClusterServerlessScalingConfigurationArgs{...}

or:

        nil

func DbClusterServerlessScalingConfigurationPtr added in v0.72.0 

func DbClusterServerlessScalingConfigurationPtr(v *DbClusterServerlessScalingConfigurationArgs) DbClusterServerlessScalingConfigurationPtrInput

type DbClusterServerlessScalingConfigurationPtrOutput added in v0.72.0 

type DbClusterServerlessScalingConfigurationPtrOutput struct{ *pulumi.OutputState }

func (DbClusterServerlessScalingConfigurationPtrOutput) Elem added in v0.72.0 

func (o DbClusterServerlessScalingConfigurationPtrOutput) Elem() DbClusterServerlessScalingConfigurationOutput

func (DbClusterServerlessScalingConfigurationPtrOutput) ElementType added in v0.72.0 

func (DbClusterServerlessScalingConfigurationPtrOutput) ElementType() reflect.Type

func (DbClusterServerlessScalingConfigurationPtrOutput) MaxCapacity added in v0.72.0 

func (o DbClusterServerlessScalingConfigurationPtrOutput) MaxCapacity() pulumi.Float64PtrOutput

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.

func (DbClusterServerlessScalingConfigurationPtrOutput) MinCapacity added in v0.72.0 

func (o DbClusterServerlessScalingConfigurationPtrOutput) MinCapacity() pulumi.Float64PtrOutput

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.

func (DbClusterServerlessScalingConfigurationPtrOutput) ToDbClusterServerlessScalingConfigurationPtrOutput added in v0.72.0 

func (o DbClusterServerlessScalingConfigurationPtrOutput) ToDbClusterServerlessScalingConfigurationPtrOutput() DbClusterServerlessScalingConfigurationPtrOutput

func (DbClusterServerlessScalingConfigurationPtrOutput) ToDbClusterServerlessScalingConfigurationPtrOutputWithContext added in v0.72.0 

func (o DbClusterServerlessScalingConfigurationPtrOutput) ToDbClusterServerlessScalingConfigurationPtrOutputWithContext(ctx context.Context) DbClusterServerlessScalingConfigurationPtrOutput

type DbClusterState added in v0.72.0 

type DbClusterState struct {
}

func (DbClusterState) ElementType added in v0.72.0 

func (DbClusterState) ElementType() reflect.Type

type DbClusterTag added in v0.72.0 

type DbClusterTag struct {
	// 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 -.
	Key string `pulumi:"key"`
	// 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 -.
	Value *string `pulumi:"value"`
}

A key-value pair to associate with a resource.

type LookupDbClusterArgs added in v0.72.0 

type LookupDbClusterArgs struct {
	// 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 `pulumi:"dbClusterIdentifier"`
}

type LookupDbClusterOutputArgs added in v0.72.0 

type LookupDbClusterOutputArgs struct {
	// 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 pulumi.StringInput `pulumi:"dbClusterIdentifier"`
}

func (LookupDbClusterOutputArgs) ElementType added in v0.72.0 

func (LookupDbClusterOutputArgs) ElementType() reflect.Type

type LookupDbClusterResult added in v0.72.0 

type LookupDbClusterResult struct {
	// 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.
	AssociatedRoles []DbClusterDbClusterRole `pulumi:"associatedRoles"`
	// Specifies the number of days for which automatic DB snapshots are retained.
	BackupRetentionPeriod *int `pulumi:"backupRetentionPeriod"`
	// 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.
	ClusterResourceId *string `pulumi:"clusterResourceId"`
	// 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.
	CopyTagsToSnapshot *bool `pulumi:"copyTagsToSnapshot"`
	// Provides the name of the DB cluster parameter group.
	DbClusterParameterGroupName *string `pulumi:"dbClusterParameterGroupName"`
	// 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.
	DbPort *int `pulumi:"dbPort"`
	// Indicates whether or not the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.
	DeletionProtection *bool `pulumi:"deletionProtection"`
	// Specifies a list of log types that are enabled for export to CloudWatch Logs.
	EnableCloudwatchLogsExports []string `pulumi:"enableCloudwatchLogsExports"`
	// The connection endpoint for the DB cluster. For example: `mystack-mydbcluster-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com`
	Endpoint *string `pulumi:"endpoint"`
	// Indicates the database engine version.
	EngineVersion *string `pulumi:"engineVersion"`
	// True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
	IamAuthEnabled *bool `pulumi:"iamAuthEnabled"`
	// The port number on which the DB cluster accepts connections. For example: `8182`.
	Port *string `pulumi:"port"`
	// Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
	PreferredBackupWindow *string `pulumi:"preferredBackupWindow"`
	// Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
	PreferredMaintenanceWindow *string `pulumi:"preferredMaintenanceWindow"`
	// The reader endpoint for the DB cluster. For example: `mystack-mydbcluster-ro-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com`
	ReadEndpoint *string `pulumi:"readEndpoint"`
	// Contains the scaling configuration used by the Neptune Serverless Instances within this DB cluster.
	ServerlessScalingConfiguration *DbClusterServerlessScalingConfiguration `pulumi:"serverlessScalingConfiguration"`
	// The tags assigned to this cluster.
	Tags []aws.Tag `pulumi:"tags"`
	// Provides a list of VPC security groups that the DB cluster belongs to.
	VpcSecurityGroupIds []string `pulumi:"vpcSecurityGroupIds"`
}

func LookupDbCluster added in v0.72.0 

func LookupDbCluster(ctx *pulumi.Context, args *LookupDbClusterArgs, opts ...pulumi.InvokeOption) (*LookupDbClusterResult, error)

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

type LookupDbClusterResultOutput added in v0.72.0 

type LookupDbClusterResultOutput struct{ *pulumi.OutputState }

func LookupDbClusterOutput added in v0.72.0 

func LookupDbClusterOutput(ctx *pulumi.Context, args LookupDbClusterOutputArgs, opts ...pulumi.InvokeOption) LookupDbClusterResultOutput

func (LookupDbClusterResultOutput) AssociatedRoles added in v0.72.0 

func (o LookupDbClusterResultOutput) AssociatedRoles() DbClusterDbClusterRoleArrayOutput

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.

func (LookupDbClusterResultOutput) BackupRetentionPeriod added in v0.72.0 

func (o LookupDbClusterResultOutput) BackupRetentionPeriod() pulumi.IntPtrOutput

Specifies the number of days for which automatic DB snapshots are retained.

func (LookupDbClusterResultOutput) ClusterResourceId added in v0.72.0 

func (o LookupDbClusterResultOutput) ClusterResourceId() pulumi.StringPtrOutput

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.

func (LookupDbClusterResultOutput) CopyTagsToSnapshot added in v0.72.0 

func (o LookupDbClusterResultOutput) CopyTagsToSnapshot() pulumi.BoolPtrOutput

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.

func (LookupDbClusterResultOutput) DbClusterParameterGroupName added in v0.72.0 

func (o LookupDbClusterResultOutput) DbClusterParameterGroupName() pulumi.StringPtrOutput

Provides the name of the DB cluster parameter group.

func (LookupDbClusterResultOutput) DbPort added in v0.73.0 

func (o LookupDbClusterResultOutput) DbPort() pulumi.IntPtrOutput

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.

func (LookupDbClusterResultOutput) DeletionProtection added in v0.72.0 

func (o LookupDbClusterResultOutput) DeletionProtection() pulumi.BoolPtrOutput

Indicates whether or not the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.

func (LookupDbClusterResultOutput) ElementType added in v0.72.0 

func (LookupDbClusterResultOutput) ElementType() reflect.Type

func (LookupDbClusterResultOutput) EnableCloudwatchLogsExports added in v0.72.0 

func (o LookupDbClusterResultOutput) EnableCloudwatchLogsExports() pulumi.StringArrayOutput

Specifies a list of log types that are enabled for export to CloudWatch Logs.

func (LookupDbClusterResultOutput) Endpoint added in v0.72.0 

func (o LookupDbClusterResultOutput) Endpoint() pulumi.StringPtrOutput

The connection endpoint for the DB cluster. For example: `mystack-mydbcluster-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com`

func (LookupDbClusterResultOutput) EngineVersion added in v0.72.0 

func (o LookupDbClusterResultOutput) EngineVersion() pulumi.StringPtrOutput

Indicates the database engine version.

func (LookupDbClusterResultOutput) IamAuthEnabled added in v0.72.0 

func (o LookupDbClusterResultOutput) IamAuthEnabled() pulumi.BoolPtrOutput

True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

func (LookupDbClusterResultOutput) Port added in v0.72.0 

func (o LookupDbClusterResultOutput) Port() pulumi.StringPtrOutput

The port number on which the DB cluster accepts connections. For example: `8182`.

func (LookupDbClusterResultOutput) PreferredBackupWindow added in v0.72.0 

func (o LookupDbClusterResultOutput) PreferredBackupWindow() pulumi.StringPtrOutput

Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

func (LookupDbClusterResultOutput) PreferredMaintenanceWindow added in v0.72.0 

func (o LookupDbClusterResultOutput) PreferredMaintenanceWindow() pulumi.StringPtrOutput

Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

func (LookupDbClusterResultOutput) ReadEndpoint added in v0.72.0 

func (o LookupDbClusterResultOutput) ReadEndpoint() pulumi.StringPtrOutput

The reader endpoint for the DB cluster. For example: `mystack-mydbcluster-ro-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com`

func (LookupDbClusterResultOutput) ServerlessScalingConfiguration added in v0.72.0 

func (o LookupDbClusterResultOutput) ServerlessScalingConfiguration() DbClusterServerlessScalingConfigurationPtrOutput

Contains the scaling configuration used by the Neptune Serverless Instances within this DB cluster.

func (LookupDbClusterResultOutput) Tags added in v0.72.0 

func (o LookupDbClusterResultOutput) Tags() aws.TagArrayOutput

The tags assigned to this cluster.

func (LookupDbClusterResultOutput) ToLookupDbClusterResultOutput added in v0.72.0 

func (o LookupDbClusterResultOutput) ToLookupDbClusterResultOutput() LookupDbClusterResultOutput

func (LookupDbClusterResultOutput) ToLookupDbClusterResultOutputWithContext added in v0.72.0 

func (o LookupDbClusterResultOutput) ToLookupDbClusterResultOutputWithContext(ctx context.Context) LookupDbClusterResultOutput

func (LookupDbClusterResultOutput) VpcSecurityGroupIds added in v0.72.0 

func (o LookupDbClusterResultOutput) VpcSecurityGroupIds() pulumi.StringArrayOutput

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.