Class ClusterState

Inheritance

System.Object

InputArgs

ResourceArgs

ClusterState

Inherited Members

ResourceArgs.Empty

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 ClusterState : ResourceArgs

Constructors

ClusterState()

Declaration

public ClusterState()

Properties

ApplyImmediately

Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is false.

Declaration

public Input<bool> ApplyImmediately { get; set; }

Property Value

Type	Description
Input<System.Boolean>

Arn

Amazon Resource Name (ARN) of cluster

Declaration

public Input<string> Arn { get; set; }

Property Value

Type	Description
Input<System.String>

AvailabilityZones

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

Declaration

public InputList<string> AvailabilityZones { get; set; }

Property Value

Type	Description
InputList<System.String>

BackupRetentionPeriod

The days to retain backups for. Default 1

Declaration

public Input<int> BackupRetentionPeriod { get; set; }

Property Value

Type	Description
Input<System.Int32>

ClusterIdentifier

The cluster identifier. If omitted, this provider will assign a random, unique identifier.

Declaration

public Input<string> ClusterIdentifier { get; set; }

Property Value

Type	Description
Input<System.String>

ClusterIdentifierPrefix

Creates a unique cluster identifier beginning with the specified prefix. Conflicts with cluster_identifer.

Declaration

public Input<string> ClusterIdentifierPrefix { get; set; }

Property Value

Type	Description
Input<System.String>

ClusterMembers

List of DocDB Instances that are a part of this cluster

Declaration

public InputList<string> ClusterMembers { get; set; }

Property Value

Type	Description
InputList<System.String>

ClusterResourceId

The DocDB Cluster Resource ID

Declaration

public Input<string> ClusterResourceId { get; set; }

Property Value

Type	Description
Input<System.String>

DbClusterParameterGroupName

A cluster parameter group to associate with the cluster.

Declaration

public Input<string> DbClusterParameterGroupName { get; set; }

Property Value

Type	Description
Input<System.String>

DbSubnetGroupName

A DB subnet group to associate with this DB instance.

Declaration

public Input<string> DbSubnetGroupName { get; set; }

Property Value

Type	Description
Input<System.String>

DeletionProtection

A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.

Declaration

public Input<bool> DeletionProtection { get; set; }

Property Value

Type	Description
Input<System.Boolean>

EnabledCloudwatchLogsExports

List of log types to export to cloudwatch. If omitted, no logs will be exported. The following log types are supported: audit, profiler.

Declaration

public InputList<string> EnabledCloudwatchLogsExports { get; set; }

Property Value

Type	Description
InputList<System.String>

Endpoint

The DNS address of the DocDB instance

Declaration

public Input<string> Endpoint { get; set; }

Property Value

Type	Description
Input<System.String>

Engine

The name of the database engine to be used for this DB cluster. Defaults to docdb. Valid Values: docdb

Declaration

public Input<string> Engine { get; set; }

Property Value

Type	Description
Input<System.String>

EngineVersion

The database engine version. Updating this argument results in an outage.

Declaration

public Input<string> EngineVersion { get; set; }

Property Value

Type	Description
Input<System.String>

FinalSnapshotIdentifier

The name of your final DB snapshot when this DB cluster is deleted. If omitted, no final snapshot will be made.

Declaration

public Input<string> FinalSnapshotIdentifier { get; set; }

Property Value

Type	Description
Input<System.String>

HostedZoneId

The Route53 Hosted Zone ID of the endpoint

Declaration

public Input<string> HostedZoneId { get; set; }

Property Value

Type	Description
Input<System.String>

KmsKeyId

The ARN for the KMS encryption key. When specifying kms_key_id, storage_encrypted needs to be set to true.

Declaration

public Input<string> KmsKeyId { get; set; }

Property Value

Type	Description
Input<System.String>

MasterPassword

Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file. Please refer to the DocDB Naming Constraints.

Declaration

public Input<string> MasterPassword { get; set; }

Property Value

Type	Description
Input<System.String>

MasterUsername

Username for the master DB user.

Declaration

public Input<string> MasterUsername { get; set; }

Property Value

Type	Description
Input<System.String>

Port

The port on which the DB accepts connections

Declaration

public Input<int> Port { get; set; }

Property Value

Type	Description
Input<System.Int32>

PreferredBackupWindow

The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.Time in UTC Default: A 30-minute window selected at random from an 8-hour block of time per region. e.g. 04:00-09:00

Declaration

public Input<string> PreferredBackupWindow { get; set; }

Property Value

Type	Description
Input<System.String>

PreferredMaintenanceWindow

Declaration

public Input<string> PreferredMaintenanceWindow { get; set; }

Property Value

Type	Description
Input<System.String>

ReaderEndpoint

A read-only endpoint for the DocDB cluster, automatically load-balanced across replicas

Declaration

public Input<string> ReaderEndpoint { get; set; }

Property Value

Type	Description
Input<System.String>

SkipFinalSnapshot

Determines whether a final DB snapshot is created before the DB cluster is deleted. If true is specified, no DB snapshot is created. If false is specified, a DB snapshot is created before the DB cluster is deleted, using the value from final_snapshot_identifier. Default is false.

Declaration

public Input<bool> SkipFinalSnapshot { get; set; }

Property Value

Type	Description
Input<System.Boolean>

SnapshotIdentifier

Specifies whether or not to create this cluster from a snapshot. You can use either the name or ARN when specifying a DB cluster snapshot, or the ARN when specifying a DB snapshot.

Declaration

public Input<string> SnapshotIdentifier { get; set; }

Property Value

Type	Description
Input<System.String>

StorageEncrypted

Specifies whether the DB cluster is encrypted. The default is false.

Declaration

public Input<bool> StorageEncrypted { get; set; }

Property Value

Type	Description
Input<System.Boolean>

Tags

A map of tags to assign to the DB cluster.

Declaration

public InputMap<object> Tags { get; set; }

Property Value

Type	Description
InputMap<System.Object>

VpcSecurityGroupIds

List of VPC security groups to associate with the Cluster

Declaration

public InputList<string> VpcSecurityGroupIds { get; set; }

Property Value

Type	Description
InputList<System.String>