com.pulumi.aws.rds.GlobalClusterArgs Maven / Gradle / Ivy
// *** WARNING: this file was generated by pulumi-java-gen. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
package com.pulumi.aws.rds;
import com.pulumi.core.Output;
import com.pulumi.core.annotations.Import;
import com.pulumi.exceptions.MissingRequiredPropertyException;
import java.lang.Boolean;
import java.lang.String;
import java.util.Objects;
import java.util.Optional;
import javax.annotation.Nullable;
public final class GlobalClusterArgs extends com.pulumi.resources.ResourceArgs {
public static final GlobalClusterArgs Empty = new GlobalClusterArgs();
/**
* Name for an automatically created database on cluster creation.
*
*/
@Import(name="databaseName")
private @Nullable Output databaseName;
/**
* @return Name for an automatically created database on cluster creation.
*
*/
public Optional> databaseName() {
return Optional.ofNullable(this.databaseName);
}
/**
* 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`.
*
*/
@Import(name="deletionProtection")
private @Nullable Output deletionProtection;
/**
* @return 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`.
*
*/
public Optional> deletionProtection() {
return Optional.ofNullable(this.deletionProtection);
}
/**
* 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 `source_db_cluster_identifier`.
*
*/
@Import(name="engine")
private @Nullable Output engine;
/**
* @return 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 `source_db_cluster_identifier`.
*
*/
public Optional> engine() {
return Optional.ofNullable(this.engine);
}
/**
* The 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
*
*/
@Import(name="engineLifecycleSupport")
private @Nullable Output engineLifecycleSupport;
/**
* @return The 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
*
*/
public Optional> engineLifecycleSupport() {
return Optional.ofNullable(this.engineLifecycleSupport);
}
/**
* Engine version of the Aurora global database. The `engine`, `engine_version`, and `instance_class` (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` `ignore_changes` for `engine_version` meta argument on the associated `aws.rds.Cluster` resource as shown above in Upgrading Engine Versions example.
*
*/
@Import(name="engineVersion")
private @Nullable Output engineVersion;
/**
* @return Engine version of the Aurora global database. The `engine`, `engine_version`, and `instance_class` (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` `ignore_changes` for `engine_version` meta argument on the associated `aws.rds.Cluster` resource as shown above in Upgrading Engine Versions example.
*
*/
public Optional> engineVersion() {
return Optional.ofNullable(this.engineVersion);
}
/**
* Enable to remove DB Cluster members from Global Cluster on destroy. Required with `source_db_cluster_identifier`.
*
*/
@Import(name="forceDestroy")
private @Nullable Output forceDestroy;
/**
* @return Enable to remove DB Cluster members from Global Cluster on destroy. Required with `source_db_cluster_identifier`.
*
*/
public Optional> forceDestroy() {
return Optional.ofNullable(this.forceDestroy);
}
/**
* Global cluster identifier.
*
*/
@Import(name="globalClusterIdentifier", required=true)
private Output globalClusterIdentifier;
/**
* @return Global cluster identifier.
*
*/
public Output globalClusterIdentifier() {
return this.globalClusterIdentifier;
}
/**
* Amazon Resource Name (ARN) to use as the primary DB Cluster of the Global Cluster on creation. The provider cannot perform drift detection of this value.
*
*/
@Import(name="sourceDbClusterIdentifier")
private @Nullable Output sourceDbClusterIdentifier;
/**
* @return Amazon Resource Name (ARN) to use as the primary DB Cluster of the Global Cluster on creation. The provider cannot perform drift detection of this value.
*
*/
public Optional> sourceDbClusterIdentifier() {
return Optional.ofNullable(this.sourceDbClusterIdentifier);
}
/**
* Specifies whether the DB cluster is encrypted. The default is `false` unless `source_db_cluster_identifier` is specified and encrypted. The provider will only perform drift detection if a configuration value is provided.
*
*/
@Import(name="storageEncrypted")
private @Nullable Output storageEncrypted;
/**
* @return Specifies whether the DB cluster is encrypted. The default is `false` unless `source_db_cluster_identifier` is specified and encrypted. The provider will only perform drift detection if a configuration value is provided.
*
*/
public Optional> storageEncrypted() {
return Optional.ofNullable(this.storageEncrypted);
}
private GlobalClusterArgs() {}
private GlobalClusterArgs(GlobalClusterArgs $) {
this.databaseName = $.databaseName;
this.deletionProtection = $.deletionProtection;
this.engine = $.engine;
this.engineLifecycleSupport = $.engineLifecycleSupport;
this.engineVersion = $.engineVersion;
this.forceDestroy = $.forceDestroy;
this.globalClusterIdentifier = $.globalClusterIdentifier;
this.sourceDbClusterIdentifier = $.sourceDbClusterIdentifier;
this.storageEncrypted = $.storageEncrypted;
}
public static Builder builder() {
return new Builder();
}
public static Builder builder(GlobalClusterArgs defaults) {
return new Builder(defaults);
}
public static final class Builder {
private GlobalClusterArgs $;
public Builder() {
$ = new GlobalClusterArgs();
}
public Builder(GlobalClusterArgs defaults) {
$ = new GlobalClusterArgs(Objects.requireNonNull(defaults));
}
/**
* @param databaseName Name for an automatically created database on cluster creation.
*
* @return builder
*
*/
public Builder databaseName(@Nullable Output databaseName) {
$.databaseName = databaseName;
return this;
}
/**
* @param databaseName Name for an automatically created database on cluster creation.
*
* @return builder
*
*/
public Builder databaseName(String databaseName) {
return databaseName(Output.of(databaseName));
}
/**
* @param 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`.
*
* @return builder
*
*/
public Builder deletionProtection(@Nullable Output deletionProtection) {
$.deletionProtection = deletionProtection;
return this;
}
/**
* @param 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`.
*
* @return builder
*
*/
public Builder deletionProtection(Boolean deletionProtection) {
return deletionProtection(Output.of(deletionProtection));
}
/**
* @param 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 `source_db_cluster_identifier`.
*
* @return builder
*
*/
public Builder engine(@Nullable Output engine) {
$.engine = engine;
return this;
}
/**
* @param 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 `source_db_cluster_identifier`.
*
* @return builder
*
*/
public Builder engine(String engine) {
return engine(Output.of(engine));
}
/**
* @param engineLifecycleSupport The 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
*
* @return builder
*
*/
public Builder engineLifecycleSupport(@Nullable Output engineLifecycleSupport) {
$.engineLifecycleSupport = engineLifecycleSupport;
return this;
}
/**
* @param engineLifecycleSupport The 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
*
* @return builder
*
*/
public Builder engineLifecycleSupport(String engineLifecycleSupport) {
return engineLifecycleSupport(Output.of(engineLifecycleSupport));
}
/**
* @param engineVersion Engine version of the Aurora global database. The `engine`, `engine_version`, and `instance_class` (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` `ignore_changes` for `engine_version` meta argument on the associated `aws.rds.Cluster` resource as shown above in Upgrading Engine Versions example.
*
* @return builder
*
*/
public Builder engineVersion(@Nullable Output engineVersion) {
$.engineVersion = engineVersion;
return this;
}
/**
* @param engineVersion Engine version of the Aurora global database. The `engine`, `engine_version`, and `instance_class` (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` `ignore_changes` for `engine_version` meta argument on the associated `aws.rds.Cluster` resource as shown above in Upgrading Engine Versions example.
*
* @return builder
*
*/
public Builder engineVersion(String engineVersion) {
return engineVersion(Output.of(engineVersion));
}
/**
* @param forceDestroy Enable to remove DB Cluster members from Global Cluster on destroy. Required with `source_db_cluster_identifier`.
*
* @return builder
*
*/
public Builder forceDestroy(@Nullable Output forceDestroy) {
$.forceDestroy = forceDestroy;
return this;
}
/**
* @param forceDestroy Enable to remove DB Cluster members from Global Cluster on destroy. Required with `source_db_cluster_identifier`.
*
* @return builder
*
*/
public Builder forceDestroy(Boolean forceDestroy) {
return forceDestroy(Output.of(forceDestroy));
}
/**
* @param globalClusterIdentifier Global cluster identifier.
*
* @return builder
*
*/
public Builder globalClusterIdentifier(Output globalClusterIdentifier) {
$.globalClusterIdentifier = globalClusterIdentifier;
return this;
}
/**
* @param globalClusterIdentifier Global cluster identifier.
*
* @return builder
*
*/
public Builder globalClusterIdentifier(String globalClusterIdentifier) {
return globalClusterIdentifier(Output.of(globalClusterIdentifier));
}
/**
* @param sourceDbClusterIdentifier Amazon Resource Name (ARN) to use as the primary DB Cluster of the Global Cluster on creation. The provider cannot perform drift detection of this value.
*
* @return builder
*
*/
public Builder sourceDbClusterIdentifier(@Nullable Output sourceDbClusterIdentifier) {
$.sourceDbClusterIdentifier = sourceDbClusterIdentifier;
return this;
}
/**
* @param sourceDbClusterIdentifier Amazon Resource Name (ARN) to use as the primary DB Cluster of the Global Cluster on creation. The provider cannot perform drift detection of this value.
*
* @return builder
*
*/
public Builder sourceDbClusterIdentifier(String sourceDbClusterIdentifier) {
return sourceDbClusterIdentifier(Output.of(sourceDbClusterIdentifier));
}
/**
* @param storageEncrypted Specifies whether the DB cluster is encrypted. The default is `false` unless `source_db_cluster_identifier` is specified and encrypted. The provider will only perform drift detection if a configuration value is provided.
*
* @return builder
*
*/
public Builder storageEncrypted(@Nullable Output storageEncrypted) {
$.storageEncrypted = storageEncrypted;
return this;
}
/**
* @param storageEncrypted Specifies whether the DB cluster is encrypted. The default is `false` unless `source_db_cluster_identifier` is specified and encrypted. The provider will only perform drift detection if a configuration value is provided.
*
* @return builder
*
*/
public Builder storageEncrypted(Boolean storageEncrypted) {
return storageEncrypted(Output.of(storageEncrypted));
}
public GlobalClusterArgs build() {
if ($.globalClusterIdentifier == null) {
throw new MissingRequiredPropertyException("GlobalClusterArgs", "globalClusterIdentifier");
}
return $;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy