Interface GlobalCluster.Builder

All Superinterfaces:
Buildable, CopyableBuilder<GlobalCluster.Builder,GlobalCluster>, SdkBuilder<GlobalCluster.Builder,GlobalCluster>, SdkPojo
Enclosing class:
GlobalCluster
@Mutable @NotThreadSafe public static interface GlobalCluster.Builder extends SdkPojo, CopyableBuilder<GlobalCluster.Builder,GlobalCluster>

  • Method Details

    • globalClusterIdentifier

      GlobalCluster.Builder globalClusterIdentifier(String globalClusterIdentifier)

      Contains a user-supplied global cluster identifier. This identifier is the unique key that identifies a global cluster.

      Parameters:
      globalClusterIdentifier - Contains a user-supplied global cluster identifier. This identifier is the unique key that identifies a global cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • globalClusterResourceId

      GlobalCluster.Builder globalClusterResourceId(String globalClusterResourceId)

      The Amazon Web Services RegionRegion-unique, immutable identifier for the global database cluster. This identifier is found in CloudTrail log entries whenever the KMS customer master key (CMK) for the cluster is accessed.

      Parameters:
      globalClusterResourceId - The Amazon Web Services RegionRegion-unique, immutable identifier for the global database cluster. This identifier is found in CloudTrail log entries whenever the KMS customer master key (CMK) for the cluster is accessed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • globalClusterArn

      GlobalCluster.Builder globalClusterArn(String globalClusterArn)

      The Amazon Resource Name (ARN) for the global cluster.

      Parameters:
      globalClusterArn - The Amazon Resource Name (ARN) for the global cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • status

      GlobalCluster.Builder status(String status)

      Specifies the current state of this global cluster.

      Parameters:
      status - Specifies the current state of this global cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • engine

      GlobalCluster.Builder engine(String engine)

      The Amazon DocumentDB database engine used by the global cluster.

      Parameters:
      engine - The Amazon DocumentDB database engine used by the global cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • engineVersion

      GlobalCluster.Builder engineVersion(String engineVersion)

      Indicates the database engine version.

      Parameters:
      engineVersion - Indicates the database engine version.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • databaseName

      GlobalCluster.Builder databaseName(String databaseName)

      The default database name within the new global cluster.

      Parameters:
      databaseName - The default database name within the new global cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • storageEncrypted

      GlobalCluster.Builder storageEncrypted(Boolean storageEncrypted)

      The storage encryption setting for the global cluster.

      Parameters:
      storageEncrypted - The storage encryption setting for the global cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • deletionProtection

      GlobalCluster.Builder deletionProtection(Boolean deletionProtection)

      The deletion protection setting for the new global cluster.

      Parameters:
      deletionProtection - The deletion protection setting for the new global cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • globalClusterMembers

      GlobalCluster.Builder globalClusterMembers(Collection<GlobalClusterMember> globalClusterMembers)

      The list of cluster IDs for secondary clusters within the global cluster. Currently limited to one item.

      Parameters:
      globalClusterMembers - The list of cluster IDs for secondary clusters within the global cluster. Currently limited to one item.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • globalClusterMembers

      GlobalCluster.Builder globalClusterMembers(GlobalClusterMember... globalClusterMembers)

      The list of cluster IDs for secondary clusters within the global cluster. Currently limited to one item.

      Parameters:
      globalClusterMembers - The list of cluster IDs for secondary clusters within the global cluster. Currently limited to one item.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • globalClusterMembers

      GlobalCluster.Builder globalClusterMembers(Consumer<GlobalClusterMember.Builder>... globalClusterMembers)

      The list of cluster IDs for secondary clusters within the global cluster. Currently limited to one item.

      This is a convenience method that creates an instance of the GlobalClusterMember.Builder avoiding the need to create one manually via GlobalClusterMember.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to globalClusterMembers(List<GlobalClusterMember>).

      Parameters:
      globalClusterMembers - a consumer that will call methods on GlobalClusterMember.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • failoverState

      GlobalCluster.Builder failoverState(FailoverState failoverState)

      A data object containing all properties for the current state of an in-process or pending switchover or failover process for this global cluster. This object is empty unless the SwitchoverGlobalCluster or FailoverGlobalCluster operation was called on this global cluster.

      Parameters:
      failoverState - A data object containing all properties for the current state of an in-process or pending switchover or failover process for this global cluster. This object is empty unless the SwitchoverGlobalCluster or FailoverGlobalCluster operation was called on this global cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • failoverState

      default GlobalCluster.Builder failoverState(Consumer<FailoverState.Builder> failoverState)

      A data object containing all properties for the current state of an in-process or pending switchover or failover process for this global cluster. This object is empty unless the SwitchoverGlobalCluster or FailoverGlobalCluster operation was called on this global cluster.

      This is a convenience method that creates an instance of the FailoverState.Builder avoiding the need to create one manually via FailoverState.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to failoverState(FailoverState).

      Parameters:
      failoverState - a consumer that will call methods on FailoverState.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • tagList

      GlobalCluster.Builder tagList(Collection<Tag> tagList)

      A list of global cluster tags.

      Parameters:
      tagList - A list of global cluster tags.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tagList

      GlobalCluster.Builder tagList(Tag... tagList)

      A list of global cluster tags.

      Parameters:
      tagList - A list of global cluster tags.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tagList

      GlobalCluster.Builder tagList(Consumer<Tag.Builder>... tagList)

      A list of global cluster tags.

      This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tagList(List<Tag>).

      Parameters:
      tagList - a consumer that will call methods on Tag.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: