Package com.pulumi.aws.rds
Class GlobalClusterArgs.Builder
- java.lang.Object
-
- com.pulumi.aws.rds.GlobalClusterArgs.Builder
-
- Enclosing class:
- GlobalClusterArgs
public static final class GlobalClusterArgs.Builder extends java.lang.Object
-
-
Constructor Summary
Constructors Constructor Description Builder()Builder(GlobalClusterArgs defaults)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description GlobalClusterArgsbuild()GlobalClusterArgs.BuilderdatabaseName(com.pulumi.core.Output<java.lang.String> databaseName)GlobalClusterArgs.BuilderdatabaseName(java.lang.String databaseName)GlobalClusterArgs.BuilderdeletionProtection(com.pulumi.core.Output<java.lang.Boolean> deletionProtection)GlobalClusterArgs.BuilderdeletionProtection(java.lang.Boolean deletionProtection)GlobalClusterArgs.Builderengine(com.pulumi.core.Output<java.lang.String> engine)GlobalClusterArgs.Builderengine(java.lang.String engine)GlobalClusterArgs.BuilderengineLifecycleSupport(com.pulumi.core.Output<java.lang.String> engineLifecycleSupport)GlobalClusterArgs.BuilderengineLifecycleSupport(java.lang.String engineLifecycleSupport)GlobalClusterArgs.BuilderengineVersion(com.pulumi.core.Output<java.lang.String> engineVersion)GlobalClusterArgs.BuilderengineVersion(java.lang.String engineVersion)GlobalClusterArgs.BuilderforceDestroy(com.pulumi.core.Output<java.lang.Boolean> forceDestroy)GlobalClusterArgs.BuilderforceDestroy(java.lang.Boolean forceDestroy)GlobalClusterArgs.BuilderglobalClusterIdentifier(com.pulumi.core.Output<java.lang.String> globalClusterIdentifier)GlobalClusterArgs.BuilderglobalClusterIdentifier(java.lang.String globalClusterIdentifier)GlobalClusterArgs.Builderregion(com.pulumi.core.Output<java.lang.String> region)GlobalClusterArgs.Builderregion(java.lang.String region)GlobalClusterArgs.BuildersourceDbClusterIdentifier(com.pulumi.core.Output<java.lang.String> sourceDbClusterIdentifier)GlobalClusterArgs.BuildersourceDbClusterIdentifier(java.lang.String sourceDbClusterIdentifier)GlobalClusterArgs.BuilderstorageEncrypted(com.pulumi.core.Output<java.lang.Boolean> storageEncrypted)GlobalClusterArgs.BuilderstorageEncrypted(java.lang.Boolean storageEncrypted)GlobalClusterArgs.Buildertags(com.pulumi.core.Output<java.util.Map<java.lang.String,java.lang.String>> tags)GlobalClusterArgs.Buildertags(java.util.Map<java.lang.String,java.lang.String> tags)
-
-
-
Constructor Detail
-
Builder
public Builder()
-
Builder
public Builder(GlobalClusterArgs defaults)
-
-
Method Detail
-
databaseName
public GlobalClusterArgs.Builder databaseName(@Nullable com.pulumi.core.Output<java.lang.String> databaseName)
- Parameters:
databaseName- Name for an automatically created database on cluster creation. Pulumi will only perform drift detection if a configuration value is provided.- Returns:
- builder
-
databaseName
public GlobalClusterArgs.Builder databaseName(java.lang.String databaseName)
- Parameters:
databaseName- Name for an automatically created database on cluster creation. Pulumi will only perform drift detection if a configuration value is provided.- Returns:
- builder
-
deletionProtection
public GlobalClusterArgs.Builder deletionProtection(@Nullable com.pulumi.core.Output<java.lang.Boolean> deletionProtection)
- Parameters:
deletionProtection- If the Global Cluster should have deletion protection enabled. The database can't be deleted when this value is set to `true`. The default is `false`.- Returns:
- builder
-
deletionProtection
public GlobalClusterArgs.Builder deletionProtection(java.lang.Boolean deletionProtection)
- Parameters:
deletionProtection- If the Global Cluster should have deletion protection enabled. The database can't be deleted when this value is set to `true`. The default is `false`.- Returns:
- builder
-
engine
public GlobalClusterArgs.Builder engine(@Nullable com.pulumi.core.Output<java.lang.String> engine)
- Parameters:
engine- Name of the database engine to be used for this DB cluster. The provider will only perform drift detection if a configuration value is provided. Valid values: `aurora`, `aurora-mysql`, `aurora-postgresql`. Defaults to `aurora`. Conflicts with `sourceDbClusterIdentifier`.- Returns:
- builder
-
engine
public GlobalClusterArgs.Builder engine(java.lang.String engine)
- Parameters:
engine- Name of the database engine to be used for this DB cluster. The provider will only perform drift detection if a configuration value is provided. Valid values: `aurora`, `aurora-mysql`, `aurora-postgresql`. Defaults to `aurora`. Conflicts with `sourceDbClusterIdentifier`.- Returns:
- builder
-
engineLifecycleSupport
public GlobalClusterArgs.Builder engineLifecycleSupport(@Nullable com.pulumi.core.Output<java.lang.String> engineLifecycleSupport)
- Parameters:
engineLifecycleSupport- Life cycle type for this DB instance. This setting applies only to Aurora PostgreSQL-based global databases. Valid values are `open-source-rds-extended-support`, `open-source-rds-extended-support-disabled`. Default value is `open-source-rds-extended-support`. [Using Amazon RDS Extended Support]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/extended-support.html- Returns:
- builder
-
engineLifecycleSupport
public GlobalClusterArgs.Builder engineLifecycleSupport(java.lang.String engineLifecycleSupport)
- Parameters:
engineLifecycleSupport- Life cycle type for this DB instance. This setting applies only to Aurora PostgreSQL-based global databases. Valid values are `open-source-rds-extended-support`, `open-source-rds-extended-support-disabled`. Default value is `open-source-rds-extended-support`. [Using Amazon RDS Extended Support]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/extended-support.html- Returns:
- builder
-
engineVersion
public GlobalClusterArgs.Builder engineVersion(@Nullable com.pulumi.core.Output<java.lang.String> engineVersion)
- Parameters:
engineVersion- Engine version of the Aurora global database. The `engine`, `engineVersion`, and `instanceClass` (on the `aws.rds.ClusterInstance`) must together support global databases. See [Using Amazon Aurora global databases](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database.html) for more information. By upgrading the engine version, the provider will upgrade cluster members. **NOTE:** To avoid an `inconsistent final plan` error while upgrading, use the `lifecycle` `ignoreChanges` for `engineVersion` meta argument on the associated `aws.rds.Cluster` resource as shown above in Upgrading Engine Versions example.- Returns:
- builder
-
engineVersion
public GlobalClusterArgs.Builder engineVersion(java.lang.String engineVersion)
- Parameters:
engineVersion- Engine version of the Aurora global database. The `engine`, `engineVersion`, and `instanceClass` (on the `aws.rds.ClusterInstance`) must together support global databases. See [Using Amazon Aurora global databases](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database.html) for more information. By upgrading the engine version, the provider will upgrade cluster members. **NOTE:** To avoid an `inconsistent final plan` error while upgrading, use the `lifecycle` `ignoreChanges` for `engineVersion` meta argument on the associated `aws.rds.Cluster` resource as shown above in Upgrading Engine Versions example.- Returns:
- builder
-
forceDestroy
public GlobalClusterArgs.Builder forceDestroy(@Nullable com.pulumi.core.Output<java.lang.Boolean> forceDestroy)
- Parameters:
forceDestroy- Enable to remove DB Cluster members from Global Cluster on destroy. Required with `sourceDbClusterIdentifier`.- Returns:
- builder
-
forceDestroy
public GlobalClusterArgs.Builder forceDestroy(java.lang.Boolean forceDestroy)
- Parameters:
forceDestroy- Enable to remove DB Cluster members from Global Cluster on destroy. Required with `sourceDbClusterIdentifier`.- Returns:
- builder
-
globalClusterIdentifier
public GlobalClusterArgs.Builder globalClusterIdentifier(com.pulumi.core.Output<java.lang.String> globalClusterIdentifier)
- Parameters:
globalClusterIdentifier- Global cluster identifier. The following arguments are optional:- Returns:
- builder
-
globalClusterIdentifier
public GlobalClusterArgs.Builder globalClusterIdentifier(java.lang.String globalClusterIdentifier)
- Parameters:
globalClusterIdentifier- Global cluster identifier. The following arguments are optional:- Returns:
- builder
-
region
public GlobalClusterArgs.Builder region(@Nullable com.pulumi.core.Output<java.lang.String> region)
- Parameters:
region- Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.- Returns:
- builder
-
region
public GlobalClusterArgs.Builder region(java.lang.String region)
- Parameters:
region- Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.- Returns:
- builder
-
sourceDbClusterIdentifier
public GlobalClusterArgs.Builder sourceDbClusterIdentifier(@Nullable com.pulumi.core.Output<java.lang.String> sourceDbClusterIdentifier)
- Parameters:
sourceDbClusterIdentifier- ARN to use as the primary DB Cluster of the Global Cluster on creation. Pulumi cannot perform drift detection of this value. **NOTE:** After initial creation, this argument can be removed and replaced with `engine` and `engineVersion`. This allows upgrading the engine version of the Global Cluster.- Returns:
- builder
-
sourceDbClusterIdentifier
public GlobalClusterArgs.Builder sourceDbClusterIdentifier(java.lang.String sourceDbClusterIdentifier)
- Parameters:
sourceDbClusterIdentifier- ARN to use as the primary DB Cluster of the Global Cluster on creation. Pulumi cannot perform drift detection of this value. **NOTE:** After initial creation, this argument can be removed and replaced with `engine` and `engineVersion`. This allows upgrading the engine version of the Global Cluster.- Returns:
- builder
-
storageEncrypted
public GlobalClusterArgs.Builder storageEncrypted(@Nullable com.pulumi.core.Output<java.lang.Boolean> storageEncrypted)
- Parameters:
storageEncrypted- Whether the DB cluster is encrypted. The default is `false` unless `sourceDbClusterIdentifier` is specified and encrypted. The provider will only perform drift detection if a configuration value is provided.- Returns:
- builder
-
storageEncrypted
public GlobalClusterArgs.Builder storageEncrypted(java.lang.Boolean storageEncrypted)
- Parameters:
storageEncrypted- Whether the DB cluster is encrypted. The default is `false` unless `sourceDbClusterIdentifier` is specified and encrypted. The provider will only perform drift detection if a configuration value is provided.- Returns:
- builder
-
tags
public GlobalClusterArgs.Builder tags(@Nullable com.pulumi.core.Output<java.util.Map<java.lang.String,java.lang.String>> tags)
- Parameters:
tags- Map of tags to assign to the DB cluster. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level. > When both `sourceDbClusterIdentifier` and `engine`/`engineVersion` are set, all engine related values will be ignored during creation. The global cluster will inherit the `engine` and `engineVersion` values from the source cluster. After the first apply, any differences between the inherited and configured values will trigger an in-place update.- Returns:
- builder
-
tags
public GlobalClusterArgs.Builder tags(java.util.Map<java.lang.String,java.lang.String> tags)
- Parameters:
tags- Map of tags to assign to the DB cluster. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level. > When both `sourceDbClusterIdentifier` and `engine`/`engineVersion` are set, all engine related values will be ignored during creation. The global cluster will inherit the `engine` and `engineVersion` values from the source cluster. After the first apply, any differences between the inherited and configured values will trigger an in-place update.- Returns:
- builder
-
build
public GlobalClusterArgs build()
-
-