Package com.pulumi.aws.docdb.inputs

Class ClusterState.Builder

  • Enclosing class:
    ClusterState
    public static final class ClusterState.Builder
extends java.lang.Object

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • allowMajorVersionUpgrade

        public ClusterState.Builder allowMajorVersionUpgrade​(@Nullable
                                                     com.pulumi.core.Output<java.lang.Boolean> allowMajorVersionUpgrade)
        Parameters:
        allowMajorVersionUpgrade - A value that indicates whether major version upgrades are allowed. Constraints: You must allow major version upgrades when specifying a value for the EngineVersion parameter that is a different major version than the DB cluster's current version.
        Returns:
        builder

      • allowMajorVersionUpgrade

        public ClusterState.Builder allowMajorVersionUpgrade​(java.lang.Boolean allowMajorVersionUpgrade)
        Parameters:
        allowMajorVersionUpgrade - A value that indicates whether major version upgrades are allowed. Constraints: You must allow major version upgrades when specifying a value for the EngineVersion parameter that is a different major version than the DB cluster's current version.
        Returns:
        builder

      • applyImmediately

        public ClusterState.Builder applyImmediately​(@Nullable
                                             com.pulumi.core.Output<java.lang.Boolean> applyImmediately)
        Parameters:
        applyImmediately - Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is `false`.
        Returns:
        builder

      • applyImmediately

        public ClusterState.Builder applyImmediately​(java.lang.Boolean applyImmediately)
        Parameters:
        applyImmediately - Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is `false`.
        Returns:
        builder

      • arn

        public ClusterState.Builder arn​(@Nullable
                                com.pulumi.core.Output<java.lang.String> arn)
        Parameters:
        arn - Amazon Resource Name (ARN) of cluster
        Returns:
        builder

      • arn

        public ClusterState.Builder arn​(java.lang.String arn)
        Parameters:
        arn - Amazon Resource Name (ARN) of cluster
        Returns:
        builder

      • availabilityZones

        public ClusterState.Builder availabilityZones​(@Nullable
                                              com.pulumi.core.Output<java.util.List<java.lang.String>> availabilityZones)
        Parameters:
        availabilityZones - A list of EC2 Availability Zones that instances in the DB cluster can be created in.
        Returns:
        builder

      • availabilityZones

        public ClusterState.Builder availabilityZones​(java.util.List<java.lang.String> availabilityZones)
        Parameters:
        availabilityZones - A list of EC2 Availability Zones that instances in the DB cluster can be created in.
        Returns:
        builder

      • availabilityZones

        public ClusterState.Builder availabilityZones​(java.lang.String... availabilityZones)
        Parameters:
        availabilityZones - A list of EC2 Availability Zones that instances in the DB cluster can be created in.
        Returns:
        builder

      • backupRetentionPeriod

        public ClusterState.Builder backupRetentionPeriod​(@Nullable
                                                  com.pulumi.core.Output<java.lang.Integer> backupRetentionPeriod)
        Parameters:
        backupRetentionPeriod - The days to retain backups for. Default `1`
        Returns:
        builder

      • backupRetentionPeriod

        public ClusterState.Builder backupRetentionPeriod​(java.lang.Integer backupRetentionPeriod)
        Parameters:
        backupRetentionPeriod - The days to retain backups for. Default `1`
        Returns:
        builder

      • clusterIdentifier

        public ClusterState.Builder clusterIdentifier​(@Nullable
                                              com.pulumi.core.Output<java.lang.String> clusterIdentifier)
        Parameters:
        clusterIdentifier - The cluster identifier. If omitted, the provider will assign a random, unique identifier.
        Returns:
        builder

      • clusterIdentifier

        public ClusterState.Builder clusterIdentifier​(java.lang.String clusterIdentifier)
        Parameters:
        clusterIdentifier - The cluster identifier. If omitted, the provider will assign a random, unique identifier.
        Returns:
        builder

      • clusterIdentifierPrefix

        public ClusterState.Builder clusterIdentifierPrefix​(@Nullable
                                                    com.pulumi.core.Output<java.lang.String> clusterIdentifierPrefix)
        Parameters:
        clusterIdentifierPrefix - Creates a unique cluster identifier beginning with the specified prefix. Conflicts with `cluster_identifier`.
        Returns:
        builder

      • clusterIdentifierPrefix

        public ClusterState.Builder clusterIdentifierPrefix​(java.lang.String clusterIdentifierPrefix)
        Parameters:
        clusterIdentifierPrefix - Creates a unique cluster identifier beginning with the specified prefix. Conflicts with `cluster_identifier`.
        Returns:
        builder

      • clusterMembers

        public ClusterState.Builder clusterMembers​(@Nullable
                                           com.pulumi.core.Output<java.util.List<java.lang.String>> clusterMembers)
        Parameters:
        clusterMembers - List of DocumentDB Instances that are a part of this cluster
        Returns:
        builder

      • clusterMembers

        public ClusterState.Builder clusterMembers​(java.util.List<java.lang.String> clusterMembers)
        Parameters:
        clusterMembers - List of DocumentDB Instances that are a part of this cluster
        Returns:
        builder

      • clusterMembers

        public ClusterState.Builder clusterMembers​(java.lang.String... clusterMembers)
        Parameters:
        clusterMembers - List of DocumentDB Instances that are a part of this cluster
        Returns:
        builder

      • clusterResourceId

        public ClusterState.Builder clusterResourceId​(@Nullable
                                              com.pulumi.core.Output<java.lang.String> clusterResourceId)
        Parameters:
        clusterResourceId - The DocumentDB Cluster Resource ID
        Returns:
        builder

      • clusterResourceId

        public ClusterState.Builder clusterResourceId​(java.lang.String clusterResourceId)
        Parameters:
        clusterResourceId - The DocumentDB Cluster Resource ID
        Returns:
        builder

      • dbClusterParameterGroupName

        public ClusterState.Builder dbClusterParameterGroupName​(@Nullable
                                                        com.pulumi.core.Output<java.lang.String> dbClusterParameterGroupName)
        Parameters:
        dbClusterParameterGroupName - A cluster parameter group to associate with the cluster.
        Returns:
        builder

      • dbClusterParameterGroupName

        public ClusterState.Builder dbClusterParameterGroupName​(java.lang.String dbClusterParameterGroupName)
        Parameters:
        dbClusterParameterGroupName - A cluster parameter group to associate with the cluster.
        Returns:
        builder

      • dbSubnetGroupName

        public ClusterState.Builder dbSubnetGroupName​(@Nullable
                                              com.pulumi.core.Output<java.lang.String> dbSubnetGroupName)
        Parameters:
        dbSubnetGroupName - A DB subnet group to associate with this DB instance.
        Returns:
        builder

      • dbSubnetGroupName

        public ClusterState.Builder dbSubnetGroupName​(java.lang.String dbSubnetGroupName)
        Parameters:
        dbSubnetGroupName - A DB subnet group to associate with this DB instance.
        Returns:
        builder

      • deletionProtection

        public ClusterState.Builder deletionProtection​(@Nullable
                                               com.pulumi.core.Output<java.lang.Boolean> deletionProtection)
        Parameters:
        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.
        Returns:
        builder

      • deletionProtection

        public ClusterState.Builder deletionProtection​(java.lang.Boolean deletionProtection)
        Parameters:
        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.
        Returns:
        builder

      • enabledCloudwatchLogsExports

        public ClusterState.Builder enabledCloudwatchLogsExports​(@Nullable
                                                         com.pulumi.core.Output<java.util.List<java.lang.String>> enabledCloudwatchLogsExports)
        Parameters:
        enabledCloudwatchLogsExports - List of log types to export to cloudwatch. If omitted, no logs will be exported. The following log types are supported: `audit`, `profiler`.
        Returns:
        builder

      • enabledCloudwatchLogsExports

        public ClusterState.Builder enabledCloudwatchLogsExports​(java.util.List<java.lang.String> enabledCloudwatchLogsExports)
        Parameters:
        enabledCloudwatchLogsExports - List of log types to export to cloudwatch. If omitted, no logs will be exported. The following log types are supported: `audit`, `profiler`.
        Returns:
        builder

      • enabledCloudwatchLogsExports

        public ClusterState.Builder enabledCloudwatchLogsExports​(java.lang.String... enabledCloudwatchLogsExports)
        Parameters:
        enabledCloudwatchLogsExports - List of log types to export to cloudwatch. If omitted, no logs will be exported. The following log types are supported: `audit`, `profiler`.
        Returns:
        builder

      • endpoint

        public ClusterState.Builder endpoint​(@Nullable
                                     com.pulumi.core.Output<java.lang.String> endpoint)
        Parameters:
        endpoint - The DNS address of the DocumentDB instance
        Returns:
        builder

      • endpoint

        public ClusterState.Builder endpoint​(java.lang.String endpoint)
        Parameters:
        endpoint - The DNS address of the DocumentDB instance
        Returns:
        builder

      • engine

        public ClusterState.Builder engine​(@Nullable
                                   com.pulumi.core.Output<java.lang.String> engine)
        Parameters:
        engine - The name of the database engine to be used for this DB cluster. Defaults to `docdb`. Valid values: `docdb`.
        Returns:
        builder

      • engine

        public ClusterState.Builder engine​(java.lang.String engine)
        Parameters:
        engine - The name of the database engine to be used for this DB cluster. Defaults to `docdb`. Valid values: `docdb`.
        Returns:
        builder

      • engineVersion

        public ClusterState.Builder engineVersion​(@Nullable
                                          com.pulumi.core.Output<java.lang.String> engineVersion)
        Parameters:
        engineVersion - The database engine version. Updating this argument results in an outage.
        Returns:
        builder

      • engineVersion

        public ClusterState.Builder engineVersion​(java.lang.String engineVersion)
        Parameters:
        engineVersion - The database engine version. Updating this argument results in an outage.
        Returns:
        builder

      • finalSnapshotIdentifier

        public ClusterState.Builder finalSnapshotIdentifier​(@Nullable
                                                    com.pulumi.core.Output<java.lang.String> finalSnapshotIdentifier)
        Parameters:
        finalSnapshotIdentifier - The name of your final DB snapshot when this DB cluster is deleted. If omitted, no final snapshot will be made.
        Returns:
        builder

      • finalSnapshotIdentifier

        public ClusterState.Builder finalSnapshotIdentifier​(java.lang.String finalSnapshotIdentifier)
        Parameters:
        finalSnapshotIdentifier - The name of your final DB snapshot when this DB cluster is deleted. If omitted, no final snapshot will be made.
        Returns:
        builder

      • globalClusterIdentifier

        public ClusterState.Builder globalClusterIdentifier​(@Nullable
                                                    com.pulumi.core.Output<java.lang.String> globalClusterIdentifier)
        Parameters:
        globalClusterIdentifier - The global cluster identifier specified on `aws.docdb.GlobalCluster`.
        Returns:
        builder

      • globalClusterIdentifier

        public ClusterState.Builder globalClusterIdentifier​(java.lang.String globalClusterIdentifier)
        Parameters:
        globalClusterIdentifier - The global cluster identifier specified on `aws.docdb.GlobalCluster`.
        Returns:
        builder

      • hostedZoneId

        public ClusterState.Builder hostedZoneId​(@Nullable
                                         com.pulumi.core.Output<java.lang.String> hostedZoneId)
        Parameters:
        hostedZoneId - The Route53 Hosted Zone ID of the endpoint
        Returns:
        builder

      • hostedZoneId

        public ClusterState.Builder hostedZoneId​(java.lang.String hostedZoneId)
        Parameters:
        hostedZoneId - The Route53 Hosted Zone ID of the endpoint
        Returns:
        builder

      • kmsKeyId

        public ClusterState.Builder kmsKeyId​(@Nullable
                                     com.pulumi.core.Output<java.lang.String> kmsKeyId)
        Parameters:
        kmsKeyId - The ARN for the KMS encryption key. When specifying `kms_key_id`, `storage_encrypted` needs to be set to true.
        Returns:
        builder

      • kmsKeyId

        public ClusterState.Builder kmsKeyId​(java.lang.String kmsKeyId)
        Parameters:
        kmsKeyId - The ARN for the KMS encryption key. When specifying `kms_key_id`, `storage_encrypted` needs to be set to true.
        Returns:
        builder

      • masterPassword

        public ClusterState.Builder masterPassword​(@Nullable
                                           com.pulumi.core.Output<java.lang.String> masterPassword)
        Parameters:
        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 DocumentDB Naming Constraints.
        Returns:
        builder

      • masterPassword

        public ClusterState.Builder masterPassword​(java.lang.String masterPassword)
        Parameters:
        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 DocumentDB Naming Constraints.
        Returns:
        builder

      • masterUsername

        public ClusterState.Builder masterUsername​(@Nullable
                                           com.pulumi.core.Output<java.lang.String> masterUsername)
        Parameters:
        masterUsername - Username for the master DB user.
        Returns:
        builder

      • masterUsername

        public ClusterState.Builder masterUsername​(java.lang.String masterUsername)
        Parameters:
        masterUsername - Username for the master DB user.
        Returns:
        builder

      • port

        public ClusterState.Builder port​(@Nullable
                                 com.pulumi.core.Output<java.lang.Integer> port)
        Parameters:
        port - The port on which the DB accepts connections
        Returns:
        builder

      • port

        public ClusterState.Builder port​(java.lang.Integer port)
        Parameters:
        port - The port on which the DB accepts connections
        Returns:
        builder

      • preferredBackupWindow

        public ClusterState.Builder preferredBackupWindow​(@Nullable
                                                  com.pulumi.core.Output<java.lang.String> preferredBackupWindow)
        Parameters:
        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 regionE.g., 04:00-09:00
        Returns:
        builder

      • preferredBackupWindow

        public ClusterState.Builder preferredBackupWindow​(java.lang.String preferredBackupWindow)
        Parameters:
        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 regionE.g., 04:00-09:00
        Returns:
        builder

      • preferredMaintenanceWindow

        public ClusterState.Builder preferredMaintenanceWindow​(@Nullable
                                                       com.pulumi.core.Output<java.lang.String> preferredMaintenanceWindow)
        Parameters:
        preferredMaintenanceWindow - The weekly time range during which system maintenance can occur, in (UTC) e.g., wed:04:00-wed:04:30
        Returns:
        builder

      • preferredMaintenanceWindow

        public ClusterState.Builder preferredMaintenanceWindow​(java.lang.String preferredMaintenanceWindow)
        Parameters:
        preferredMaintenanceWindow - The weekly time range during which system maintenance can occur, in (UTC) e.g., wed:04:00-wed:04:30
        Returns:
        builder

      • readerEndpoint

        public ClusterState.Builder readerEndpoint​(@Nullable
                                           com.pulumi.core.Output<java.lang.String> readerEndpoint)
        Parameters:
        readerEndpoint - A read-only endpoint for the DocumentDB cluster, automatically load-balanced across replicas
        Returns:
        builder

      • readerEndpoint

        public ClusterState.Builder readerEndpoint​(java.lang.String readerEndpoint)
        Parameters:
        readerEndpoint - A read-only endpoint for the DocumentDB cluster, automatically load-balanced across replicas
        Returns:
        builder

      • skipFinalSnapshot

        public ClusterState.Builder skipFinalSnapshot​(@Nullable
                                              com.pulumi.core.Output<java.lang.Boolean> skipFinalSnapshot)
        Parameters:
        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`.
        Returns:
        builder

      • skipFinalSnapshot

        public ClusterState.Builder skipFinalSnapshot​(java.lang.Boolean skipFinalSnapshot)
        Parameters:
        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`.
        Returns:
        builder

      • snapshotIdentifier

        public ClusterState.Builder snapshotIdentifier​(@Nullable
                                               com.pulumi.core.Output<java.lang.String> snapshotIdentifier)
        Parameters:
        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. Automated snapshots **should not** be used for this attribute, unless from a different cluster. Automated snapshots are deleted as part of cluster destruction when the resource is replaced.
        Returns:
        builder

      • snapshotIdentifier

        public ClusterState.Builder snapshotIdentifier​(java.lang.String snapshotIdentifier)
        Parameters:
        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. Automated snapshots **should not** be used for this attribute, unless from a different cluster. Automated snapshots are deleted as part of cluster destruction when the resource is replaced.
        Returns:
        builder

      • storageEncrypted

        public ClusterState.Builder storageEncrypted​(@Nullable
                                             com.pulumi.core.Output<java.lang.Boolean> storageEncrypted)
        Parameters:
        storageEncrypted - Specifies whether the DB cluster is encrypted. The default is `false`.
        Returns:
        builder

      • storageEncrypted

        public ClusterState.Builder storageEncrypted​(java.lang.Boolean storageEncrypted)
        Parameters:
        storageEncrypted - Specifies whether the DB cluster is encrypted. The default is `false`.
        Returns:
        builder

      • storageType

        public ClusterState.Builder storageType​(@Nullable
                                        com.pulumi.core.Output<java.lang.String> storageType)
        Parameters:
        storageType - The storage type to associate with the DB cluster. Valid values: `standard`, `iopt1`.
        Returns:
        builder

      • storageType

        public ClusterState.Builder storageType​(java.lang.String storageType)
        Parameters:
        storageType - The storage type to associate with the DB cluster. Valid values: `standard`, `iopt1`.
        Returns:
        builder

      • tags

        public ClusterState.Builder tags​(@Nullable
                                 com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tags)
        Parameters:
        tags - A map of tags to assign to the DB cluster. If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
        Returns:
        builder

      • tags

        public ClusterState.Builder tags​(java.util.Map<java.lang.String,​java.lang.String> tags)
        Parameters:
        tags - A map of tags to assign to the DB cluster. If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
        Returns:
        builder

      • tagsAll

        @Deprecated
public ClusterState.Builder tagsAll​(@Nullable
                                    com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll)
        Deprecated.
        Please use `tags` instead.
        Parameters:
        tagsAll - A map of tags assigned to the resource, including those inherited from the provider `default_tags` configuration block.
        Returns:
        builder

      • tagsAll

        @Deprecated
public ClusterState.Builder tagsAll​(java.util.Map<java.lang.String,​java.lang.String> tagsAll)
        Deprecated.
        Please use `tags` instead.
        Parameters:
        tagsAll - A map of tags assigned to the resource, including those inherited from the provider `default_tags` configuration block.
        Returns:
        builder

      • vpcSecurityGroupIds

        public ClusterState.Builder vpcSecurityGroupIds​(@Nullable
                                                com.pulumi.core.Output<java.util.List<java.lang.String>> vpcSecurityGroupIds)
        Parameters:
        vpcSecurityGroupIds - List of VPC security groups to associate with the Cluster
        Returns:
        builder

      • vpcSecurityGroupIds

        public ClusterState.Builder vpcSecurityGroupIds​(java.util.List<java.lang.String> vpcSecurityGroupIds)
        Parameters:
        vpcSecurityGroupIds - List of VPC security groups to associate with the Cluster
        Returns:
        builder

      • vpcSecurityGroupIds

        public ClusterState.Builder vpcSecurityGroupIds​(java.lang.String... vpcSecurityGroupIds)
        Parameters:
        vpcSecurityGroupIds - List of VPC security groups to associate with the Cluster
        Returns:
        builder