Interface AwsRdsDbClusterDetails.Builder

    • Method Detail

      • allocatedStorage

        AwsRdsDbClusterDetails.Builder allocatedStorage​(Integer allocatedStorage)

        For all database engines except Aurora, specifies the allocated storage size in gibibytes (GiB).

        Parameters:
        allocatedStorage - For all database engines except Aurora, specifies the allocated storage size in gibibytes (GiB).
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • availabilityZones

        AwsRdsDbClusterDetails.Builder availabilityZones​(Collection<String> availabilityZones)

        A list of Availability Zones (AZs) where instances in the DB cluster can be created.

        Parameters:
        availabilityZones - A list of Availability Zones (AZs) where instances in the DB cluster can be created.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • availabilityZones

        AwsRdsDbClusterDetails.Builder availabilityZones​(String... availabilityZones)

        A list of Availability Zones (AZs) where instances in the DB cluster can be created.

        Parameters:
        availabilityZones - A list of Availability Zones (AZs) where instances in the DB cluster can be created.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • backupRetentionPeriod

        AwsRdsDbClusterDetails.Builder backupRetentionPeriod​(Integer backupRetentionPeriod)

        The number of days for which automated backups are retained.

        Parameters:
        backupRetentionPeriod - The number of days for which automated backups are retained.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • databaseName

        AwsRdsDbClusterDetails.Builder databaseName​(String databaseName)

        The name of the database.

        Parameters:
        databaseName - The name of the database.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • status

        AwsRdsDbClusterDetails.Builder status​(String status)

        The current status of this DB cluster.

        Parameters:
        status - The current status of this DB cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • endpoint

        AwsRdsDbClusterDetails.Builder endpoint​(String endpoint)

        The connection endpoint for the primary instance of the DB cluster.

        Parameters:
        endpoint - The connection endpoint for the primary instance of the DB cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • readerEndpoint

        AwsRdsDbClusterDetails.Builder readerEndpoint​(String readerEndpoint)

        The reader endpoint for the DB cluster.

        Parameters:
        readerEndpoint - The reader endpoint for the DB cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • customEndpoints

        AwsRdsDbClusterDetails.Builder customEndpoints​(Collection<String> customEndpoints)

        A list of custom endpoints for the DB cluster.

        Parameters:
        customEndpoints - A list of custom endpoints for the DB cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • customEndpoints

        AwsRdsDbClusterDetails.Builder customEndpoints​(String... customEndpoints)

        A list of custom endpoints for the DB cluster.

        Parameters:
        customEndpoints - A list of custom endpoints for the DB cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • multiAz

        AwsRdsDbClusterDetails.Builder multiAz​(Boolean multiAz)

        Whether the DB cluster has instances in multiple Availability Zones.

        Parameters:
        multiAz - Whether the DB cluster has instances in multiple Availability Zones.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • engine

        AwsRdsDbClusterDetails.Builder engine​(String engine)

        The name of the database engine to use for this DB cluster. Valid values are as follows:

        • aurora

        • aurora-mysql

        • aurora-postgresql

        Parameters:
        engine - The name of the database engine to use for this DB cluster. Valid values are as follows:

        • aurora

        • aurora-mysql

        • aurora-postgresql

        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • engineVersion

        AwsRdsDbClusterDetails.Builder engineVersion​(String engineVersion)

        The version number of the database engine to use.

        Parameters:
        engineVersion - The version number of the database engine to use.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • port

        AwsRdsDbClusterDetails.Builder port​(Integer port)

        The port number on which the DB instances in the DB cluster accept connections.

        Parameters:
        port - The port number on which the DB instances in the DB cluster accept connections.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • masterUsername

        AwsRdsDbClusterDetails.Builder masterUsername​(String masterUsername)

        The name of the master user for the DB cluster.

        Parameters:
        masterUsername - The name of the master user for the DB cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • preferredBackupWindow

        AwsRdsDbClusterDetails.Builder preferredBackupWindow​(String preferredBackupWindow)

        The range of time each day when automated backups are created, if automated backups are enabled.

        Uses the format HH:MM-HH:MM. For example, 04:52-05:22.

        Parameters:
        preferredBackupWindow - The range of time each day when automated backups are created, if automated backups are enabled.

        Uses the format HH:MM-HH:MM. For example, 04:52-05:22.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • preferredMaintenanceWindow

        AwsRdsDbClusterDetails.Builder preferredMaintenanceWindow​(String preferredMaintenanceWindow)

        The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

        Uses the format <day>:HH:MM-<day>:HH:MM.

        For the day values, use mon|tue|wed|thu|fri| sat|sun.

        For example, sun:09:32-sun:10:02.

        Parameters:
        preferredMaintenanceWindow - The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

        Uses the format <day>:HH:MM-<day>:HH:MM.

        For the day values, use mon|tue|wed|thu| fri|sat|sun.

        For example, sun:09:32-sun:10:02.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • readReplicaIdentifiers

        AwsRdsDbClusterDetails.Builder readReplicaIdentifiers​(Collection<String> readReplicaIdentifiers)

        The identifiers of the read replicas that are associated with this DB cluster.

        Parameters:
        readReplicaIdentifiers - The identifiers of the read replicas that are associated with this DB cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • readReplicaIdentifiers

        AwsRdsDbClusterDetails.Builder readReplicaIdentifiers​(String... readReplicaIdentifiers)

        The identifiers of the read replicas that are associated with this DB cluster.

        Parameters:
        readReplicaIdentifiers - The identifiers of the read replicas that are associated with this DB cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • vpcSecurityGroups

        AwsRdsDbClusterDetails.Builder vpcSecurityGroups​(Collection<AwsRdsDbInstanceVpcSecurityGroup> vpcSecurityGroups)

        A list of VPC security groups that the DB cluster belongs to.

        Parameters:
        vpcSecurityGroups - A list of VPC security groups that the DB cluster belongs to.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • vpcSecurityGroups

        AwsRdsDbClusterDetails.Builder vpcSecurityGroups​(AwsRdsDbInstanceVpcSecurityGroup... vpcSecurityGroups)

        A list of VPC security groups that the DB cluster belongs to.

        Parameters:
        vpcSecurityGroups - A list of VPC security groups that the DB cluster belongs to.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • hostedZoneId

        AwsRdsDbClusterDetails.Builder hostedZoneId​(String hostedZoneId)

        Specifies the identifier that Amazon Route 53 assigns when you create a hosted zone.

        Parameters:
        hostedZoneId - Specifies the identifier that Amazon Route 53 assigns when you create a hosted zone.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • storageEncrypted

        AwsRdsDbClusterDetails.Builder storageEncrypted​(Boolean storageEncrypted)

        Whether the DB cluster is encrypted.

        Parameters:
        storageEncrypted - Whether the DB cluster is encrypted.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • kmsKeyId

        AwsRdsDbClusterDetails.Builder kmsKeyId​(String kmsKeyId)

        The ARN of the KMS master key that is used to encrypt the database instances in the DB cluster.

        Parameters:
        kmsKeyId - The ARN of the KMS master key that is used to encrypt the database instances in the DB cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • dbClusterResourceId

        AwsRdsDbClusterDetails.Builder dbClusterResourceId​(String dbClusterResourceId)

        The identifier of the DB cluster. The identifier must be unique within each Amazon Web Services Region and is immutable.

        Parameters:
        dbClusterResourceId - The identifier of the DB cluster. The identifier must be unique within each Amazon Web Services Region and is immutable.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • associatedRoles

        AwsRdsDbClusterDetails.Builder associatedRoles​(Collection<AwsRdsDbClusterAssociatedRole> associatedRoles)

        A list of the IAM roles that are associated with the DB cluster.

        Parameters:
        associatedRoles - A list of the IAM roles that are associated with the DB cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • associatedRoles

        AwsRdsDbClusterDetails.Builder associatedRoles​(AwsRdsDbClusterAssociatedRole... associatedRoles)

        A list of the IAM roles that are associated with the DB cluster.

        Parameters:
        associatedRoles - A list of the IAM roles that are associated with the DB cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • clusterCreateTime

        AwsRdsDbClusterDetails.Builder clusterCreateTime​(String clusterCreateTime)

        Indicates when the DB cluster was created, in Universal Coordinated Time (UTC).

        For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.

        Parameters:
        clusterCreateTime - Indicates when the DB cluster was created, in Universal Coordinated Time (UTC).

        For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • enabledCloudWatchLogsExports

        AwsRdsDbClusterDetails.Builder enabledCloudWatchLogsExports​(Collection<String> enabledCloudWatchLogsExports)

        A list of log types that this DB cluster is configured to export to CloudWatch Logs.

        Parameters:
        enabledCloudWatchLogsExports - A list of log types that this DB cluster is configured to export to CloudWatch Logs.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • enabledCloudWatchLogsExports

        AwsRdsDbClusterDetails.Builder enabledCloudWatchLogsExports​(String... enabledCloudWatchLogsExports)

        A list of log types that this DB cluster is configured to export to CloudWatch Logs.

        Parameters:
        enabledCloudWatchLogsExports - A list of log types that this DB cluster is configured to export to CloudWatch Logs.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • engineMode

        AwsRdsDbClusterDetails.Builder engineMode​(String engineMode)

        The database engine mode of the DB cluster.Valid values are as follows:

        • global

        • multimaster

        • parallelquery

        • provisioned

        • serverless

        Parameters:
        engineMode - The database engine mode of the DB cluster.Valid values are as follows:

        • global

        • multimaster

        • parallelquery

        • provisioned

        • serverless

        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • deletionProtection

        AwsRdsDbClusterDetails.Builder deletionProtection​(Boolean deletionProtection)

        Whether the DB cluster has deletion protection enabled.

        Parameters:
        deletionProtection - Whether the DB cluster has deletion protection enabled.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • httpEndpointEnabled

        AwsRdsDbClusterDetails.Builder httpEndpointEnabled​(Boolean httpEndpointEnabled)

        Whether the HTTP endpoint for an Aurora Serverless DB cluster is enabled.

        Parameters:
        httpEndpointEnabled - Whether the HTTP endpoint for an Aurora Serverless DB cluster is enabled.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • activityStreamStatus

        AwsRdsDbClusterDetails.Builder activityStreamStatus​(String activityStreamStatus)

        The status of the database activity stream. Valid values are as follows:

        • started

        • starting

        • stopped

        • stopping

        Parameters:
        activityStreamStatus - The status of the database activity stream. Valid values are as follows:

        • started

        • starting

        • stopped

        • stopping

        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • copyTagsToSnapshot

        AwsRdsDbClusterDetails.Builder copyTagsToSnapshot​(Boolean copyTagsToSnapshot)

        Whether tags are copied from the DB cluster to snapshots of the DB cluster.

        Parameters:
        copyTagsToSnapshot - Whether tags are copied from the DB cluster to snapshots of the DB cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • crossAccountClone

        AwsRdsDbClusterDetails.Builder crossAccountClone​(Boolean crossAccountClone)

        Whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.

        Parameters:
        crossAccountClone - Whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • domainMemberships

        AwsRdsDbClusterDetails.Builder domainMemberships​(Collection<AwsRdsDbDomainMembership> domainMemberships)

        The Active Directory domain membership records that are associated with the DB cluster.

        Parameters:
        domainMemberships - The Active Directory domain membership records that are associated with the DB cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • domainMemberships

        AwsRdsDbClusterDetails.Builder domainMemberships​(AwsRdsDbDomainMembership... domainMemberships)

        The Active Directory domain membership records that are associated with the DB cluster.

        Parameters:
        domainMemberships - The Active Directory domain membership records that are associated with the DB cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • dbClusterParameterGroup

        AwsRdsDbClusterDetails.Builder dbClusterParameterGroup​(String dbClusterParameterGroup)

        The name of the DB cluster parameter group for the DB cluster.

        Parameters:
        dbClusterParameterGroup - The name of the DB cluster parameter group for the DB cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • dbSubnetGroup

        AwsRdsDbClusterDetails.Builder dbSubnetGroup​(String dbSubnetGroup)

        The subnet group that is associated with the DB cluster, including the name, description, and subnets in the subnet group.

        Parameters:
        dbSubnetGroup - The subnet group that is associated with the DB cluster, including the name, description, and subnets in the subnet group.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • dbClusterOptionGroupMemberships

        AwsRdsDbClusterDetails.Builder dbClusterOptionGroupMemberships​(Collection<AwsRdsDbClusterOptionGroupMembership> dbClusterOptionGroupMemberships)

        The list of option group memberships for this DB cluster.

        Parameters:
        dbClusterOptionGroupMemberships - The list of option group memberships for this DB cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • dbClusterOptionGroupMemberships

        AwsRdsDbClusterDetails.Builder dbClusterOptionGroupMemberships​(AwsRdsDbClusterOptionGroupMembership... dbClusterOptionGroupMemberships)

        The list of option group memberships for this DB cluster.

        Parameters:
        dbClusterOptionGroupMemberships - The list of option group memberships for this DB cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • dbClusterIdentifier

        AwsRdsDbClusterDetails.Builder dbClusterIdentifier​(String dbClusterIdentifier)

        The DB cluster identifier that the user assigned to the cluster. This identifier is the unique key that identifies a DB cluster.

        Parameters:
        dbClusterIdentifier - The DB cluster identifier that the user assigned to the cluster. This identifier is the unique key that identifies a DB cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • dbClusterMembers

        AwsRdsDbClusterDetails.Builder dbClusterMembers​(Collection<AwsRdsDbClusterMember> dbClusterMembers)

        The list of instances that make up the DB cluster.

        Parameters:
        dbClusterMembers - The list of instances that make up the DB cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • dbClusterMembers

        AwsRdsDbClusterDetails.Builder dbClusterMembers​(AwsRdsDbClusterMember... dbClusterMembers)

        The list of instances that make up the DB cluster.

        Parameters:
        dbClusterMembers - The list of instances that make up the DB cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • iamDatabaseAuthenticationEnabled

        AwsRdsDbClusterDetails.Builder iamDatabaseAuthenticationEnabled​(Boolean iamDatabaseAuthenticationEnabled)

        Whether the mapping of IAM accounts to database accounts is enabled.

        Parameters:
        iamDatabaseAuthenticationEnabled - Whether the mapping of IAM accounts to database accounts is enabled.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • autoMinorVersionUpgrade

        AwsRdsDbClusterDetails.Builder autoMinorVersionUpgrade​(Boolean autoMinorVersionUpgrade)

        Indicates if minor version upgrades are automatically applied to the cluster.

        Parameters:
        autoMinorVersionUpgrade - Indicates if minor version upgrades are automatically applied to the cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.