Class ClusterArgs

Inheritance

System.Object

InputArgs

ResourceArgs

ClusterArgs

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

Assembly: Pulumi.Aws.dll

Syntax

public sealed class ClusterArgs : ResourceArgs

Constructors

ClusterArgs()

Declaration

public ClusterArgs()

Properties

ApplyImmediately

Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is false. See Amazon RDS Documentation for more information.

Declaration

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

Property Value

Type	Description
Input<System.Boolean>

AvailabilityZones

A list of EC2 Availability Zones for the DB cluster storage where DB cluster instances can be created. RDS automatically assigns 3 AZs if less than 3 AZs are configured, which will show as a difference requiring resource recreation next deployment. It is recommended to specify 3 AZs or use ignore_changes if necessary.

Declaration

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

Property Value

Type	Description
InputList<System.String>

BacktrackWindow

The target backtrack window, in seconds. Only available for aurora engine currently. To disable backtracking, set this value to 0. Defaults to 0. Must be between 0 and 259200 (72 hours)

Declaration

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

Property Value

Type	Description
Input<System.Int32>

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

Declaration

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

Property Value

Type	Description
Input<System.String>

ClusterMembers

List of RDS Instances that are a part of this cluster

Declaration

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

Property Value

Type	Description
InputList<System.String>

CopyTagsToSnapshot

Copy all Cluster tags to snapshots. Default is false.

Declaration

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

Property Value

Type	Description
Input<System.Boolean>

DatabaseName

Name for an automatically created database on cluster creation. There are different naming restrictions per database engine: RDS Naming Constraints

Declaration

public Input<string> DatabaseName { 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. NOTE: This must match the db_subnet_group_name specified on every aws.rds.ClusterInstance in the cluster.

Declaration

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

Property Value

Type	Description
Input<System.String>

DeletionProtection

If the DB instance should have deletion protection enabled. The database can't be deleted when this value is set to true. The default is false.

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, error, general, slowquery, postgresql (PostgreSQL).

Declaration

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

Property Value

Type	Description
InputList<System.String>

EnableHttpEndpoint

Enable HTTP endpoint (data API). Only valid when engine_mode is set to serverless.

Declaration

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

Property Value

Type	Description
Input<System.Boolean>

Engine

The name of the database engine to be used for this DB cluster. Defaults to aurora. Valid Values: aurora, aurora-mysql, aurora-postgresql

Declaration

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

Property Value

Type	Description
Input<System.String>

EngineMode

The database engine mode. Valid values: global, multimaster, parallelquery, provisioned, serverless. Defaults to: provisioned. See the RDS User Guide for limitations when using serverless.

Declaration

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

Property Value

Type	Description
Input<System.String>

EngineVersion

The database engine version. Updating this argument results in an outage. See the Aurora MySQL and Aurora Postgres documentation for your configured engine to determine this value. For example with Aurora MySQL 2, a potential value for this argument is 5.7.mysql_aurora.2.03.2.

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>

GlobalClusterIdentifier

The global cluster identifier specified on aws.rds.GlobalCluster.

Declaration

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

Property Value

Type	Description
Input<System.String>

IamDatabaseAuthenticationEnabled

Specifies whether or mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled. Please see AWS Documentation for availability and limitations.

Declaration

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

Property Value

Type	Description
Input<System.Boolean>

IamRoles

A List of ARNs for the IAM roles to associate to the RDS Cluster.

Declaration

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

Property Value

Type	Description
InputList<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 RDS Naming Constraints

Declaration

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

Property Value

Type	Description
Input<System.String>

MasterUsername

Username for the master DB user. Please refer to the RDS Naming Constraints. This argument does not support in-place updates and cannot be changed during a restore from snapshot.

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

The weekly time range during which system maintenance can occur, in (UTC) e.g. wed:04:00-wed:04:30

Declaration

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

Property Value

Type	Description
Input<System.String>

ReplicationSourceIdentifier

ARN of a source DB cluster or DB instance if this DB cluster is to be created as a Read Replica.

Declaration

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

Property Value

Type	Description
Input<System.String>

S3Import

Declaration

public Input<ClusterS3ImportArgs> S3Import { get; set; }

Property Value

Type	Description
Input<ClusterS3ImportArgs>

ScalingConfiguration

Nested attribute with scaling properties. Only valid when engine_mode is set to serverless. More details below.

Declaration

public Input<ClusterScalingConfigurationArgs> ScalingConfiguration { get; set; }

Property Value

Type	Description
Input<ClusterScalingConfigurationArgs>

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>

SourceRegion

The source region for an encrypted replica DB cluster.

Declaration

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

Property Value

Type	Description
Input<System.String>

StorageEncrypted

Specifies whether the DB cluster is encrypted. The default is false for provisioned engine_mode and true for serverless engine_mode.

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>