Class ClusterInstanceState

Inheritance
System.Object
InputArgs
ResourceArgs
ClusterInstanceState
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Pulumi.Aws.DocDB
Assembly: Pulumi.Aws.dll
Syntax
public sealed class ClusterInstanceState : ResourceArgs

Constructors

View Source

ClusterInstanceState()

Declaration
public ClusterInstanceState()

Properties

View Source

ApplyImmediately

Specifies whether any database modifications are applied immediately, or during the next maintenance window. Default isfalse.

Declaration
public Input<bool> ApplyImmediately { get; set; }
Property Value
Type Description
Input<System.Boolean>
View Source

Arn

Amazon Resource Name (ARN) of cluster instance

Declaration
public Input<string> Arn { get; set; }
Property Value
Type Description
Input<System.String>
View Source

AutoMinorVersionUpgrade

Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window. Default true.

Declaration
public Input<bool> AutoMinorVersionUpgrade { get; set; }
Property Value
Type Description
Input<System.Boolean>
View Source

AvailabilityZone

The EC2 Availability Zone that the DB instance is created in. See docs about the details.

Declaration
public Input<string> AvailabilityZone { get; set; }
Property Value
Type Description
Input<System.String>
View Source

CaCertIdentifier

(Optional) The identifier of the CA certificate for the DB instance.

Declaration
public Input<string> CaCertIdentifier { get; set; }
Property Value
Type Description
Input<System.String>
View Source

ClusterIdentifier

The identifier of the aws.docdb.Cluster in which to launch this instance.

Declaration
public Input<string> ClusterIdentifier { get; set; }
Property Value
Type Description
Input<System.String>
View Source

DbiResourceId

The region-unique, immutable identifier for the DB instance.

Declaration
public Input<string> DbiResourceId { get; set; }
Property Value
Type Description
Input<System.String>
View Source

DbSubnetGroupName

The DB subnet group to associate with this DB instance.

Declaration
public Input<string> DbSubnetGroupName { get; set; }
Property Value
Type Description
Input<System.String>
View Source

Endpoint

The DNS address for this instance. May not be writable

Declaration
public Input<string> Endpoint { get; set; }
Property Value
Type Description
Input<System.String>
View Source

Engine

The name of the database engine to be used for the DocDB instance. Defaults to docdb. Valid Values: docdb.

Declaration
public Input<string> Engine { get; set; }
Property Value
Type Description
Input<System.String>
View Source

EngineVersion

The database engine version

Declaration
public Input<string> EngineVersion { get; set; }
Property Value
Type Description
Input<System.String>
View Source

Identifier

The indentifier for the DocDB instance, if omitted, this provider will assign a random, unique identifier.

Declaration
public Input<string> Identifier { get; set; }
Property Value
Type Description
Input<System.String>
View Source

IdentifierPrefix

Creates a unique identifier beginning with the specified prefix. Conflicts with identifer.

Declaration
public Input<string> IdentifierPrefix { get; set; }
Property Value
Type Description
Input<System.String>
View Source

InstanceClass

The instance class to use. For details on CPU and memory, see Scaling for DocDB Instances. DocDB currently supports the below instance classes. Please see AWS Documentation for complete details.

  • db.r4.large
  • db.r4.xlarge
  • db.r4.2xlarge
  • db.r4.4xlarge
  • db.r4.8xlarge
  • db.r4.16xlarge
Declaration
public Input<string> InstanceClass { get; set; }
Property Value
Type Description
Input<System.String>
View Source

KmsKeyId

The ARN for the KMS encryption key if one is set to the cluster.

Declaration
public Input<string> KmsKeyId { get; set; }
Property Value
Type Description
Input<System.String>
View Source

Port

The database port

Declaration
public Input<int> Port { get; set; }
Property Value
Type Description
Input<System.Int32>
View Source

PreferredBackupWindow

The daily time range during which automated backups are created if automated backups are enabled.

Declaration
public Input<string> PreferredBackupWindow { get; set; }
Property Value
Type Description
Input<System.String>
View Source

PreferredMaintenanceWindow

The window to perform maintenance in. Syntax: "ddd:hh24:mi-ddd:hh24:mi". Eg: "Mon:00:00-Mon:03:00".

Declaration
public Input<string> PreferredMaintenanceWindow { get; set; }
Property Value
Type Description
Input<System.String>
View Source

PromotionTier

Default 0. Failover Priority setting on instance level. The reader who has lower tier has higher priority to get promoter to writer.

Declaration
public Input<int> PromotionTier { get; set; }
Property Value
Type Description
Input<System.Int32>
View Source

PubliclyAccessible

Declaration
public Input<bool> PubliclyAccessible { get; set; }
Property Value
Type Description
Input<System.Boolean>
View Source

StorageEncrypted

Specifies whether the DB cluster is encrypted.

Declaration
public Input<bool> StorageEncrypted { get; set; }
Property Value
Type Description
Input<System.Boolean>
View Source

Tags

A map of tags to assign to the instance.

Declaration
public InputMap<object> Tags { get; set; }
Property Value
Type Description
InputMap<System.Object>
View Source

Writer

Boolean indicating if this instance is writable. False indicates this instance is a read replica.

Declaration
public Input<bool> Writer { get; set; }
Property Value
Type Description
Input<System.Boolean>