Interface DescribeClusterSummary.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<DescribeClusterSummary.Builder,
,DescribeClusterSummary> SdkBuilder<DescribeClusterSummary.Builder,
,DescribeClusterSummary> SdkPojo
- Enclosing class:
DescribeClusterSummary
@Mutable
@NotThreadSafe
public static interface DescribeClusterSummary.Builder
extends SdkPojo, CopyableBuilder<DescribeClusterSummary.Builder,DescribeClusterSummary>
-
Method Summary
Modifier and TypeMethodDescriptionThe ARN of this Cluster.channelIds
(String... channelIds) An array of the IDs of the Channels that are associated with this Cluster.channelIds
(Collection<String> channelIds) An array of the IDs of the Channels that are associated with this Cluster.clusterType
(String clusterType) The hardware type for the Cluster.clusterType
(ClusterType clusterType) The hardware type for the Cluster.The ID of the Cluster.instanceRoleArn
(String instanceRoleArn) The ARN of the IAM role for the Node in this Cluster.The name that you specified for the Cluster.default DescribeClusterSummary.Builder
networkSettings
(Consumer<ClusterNetworkSettings.Builder> networkSettings) Network settings that connect the Nodes in the Cluster to one or more of the Networks that the Cluster is associated with.networkSettings
(ClusterNetworkSettings networkSettings) Network settings that connect the Nodes in the Cluster to one or more of the Networks that the Cluster is associated with.The current state of the Cluster.state
(ClusterState state) The current state of the Cluster.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
Method Details
-
arn
The ARN of this Cluster. It is automatically assigned when the Cluster is created.- Parameters:
arn
- The ARN of this Cluster. It is automatically assigned when the Cluster is created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
channelIds
An array of the IDs of the Channels that are associated with this Cluster. One Channel is associated with the Cluster as follows: A Channel belongs to a ChannelPlacementGroup. A ChannelPlacementGroup is attached to a Node. A Node belongs to a Cluster.- Parameters:
channelIds
- An array of the IDs of the Channels that are associated with this Cluster. One Channel is associated with the Cluster as follows: A Channel belongs to a ChannelPlacementGroup. A ChannelPlacementGroup is attached to a Node. A Node belongs to a Cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
channelIds
An array of the IDs of the Channels that are associated with this Cluster. One Channel is associated with the Cluster as follows: A Channel belongs to a ChannelPlacementGroup. A ChannelPlacementGroup is attached to a Node. A Node belongs to a Cluster.- Parameters:
channelIds
- An array of the IDs of the Channels that are associated with this Cluster. One Channel is associated with the Cluster as follows: A Channel belongs to a ChannelPlacementGroup. A ChannelPlacementGroup is attached to a Node. A Node belongs to a Cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
clusterType
The hardware type for the Cluster.- Parameters:
clusterType
- The hardware type for the Cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
clusterType
The hardware type for the Cluster.- Parameters:
clusterType
- The hardware type for the Cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
id
The ID of the Cluster. Unique in the AWS account. The ID is the resource-id portion of the ARN.- Parameters:
id
- The ID of the Cluster. Unique in the AWS account. The ID is the resource-id portion of the ARN.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
instanceRoleArn
The ARN of the IAM role for the Node in this Cluster. Any Nodes that are associated with this Cluster assume this role. The role gives permissions to the operations that you expect these Node to perform.- Parameters:
instanceRoleArn
- The ARN of the IAM role for the Node in this Cluster. Any Nodes that are associated with this Cluster assume this role. The role gives permissions to the operations that you expect these Node to perform.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
name
The name that you specified for the Cluster.- Parameters:
name
- The name that you specified for the Cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
networkSettings
Network settings that connect the Nodes in the Cluster to one or more of the Networks that the Cluster is associated with.- Parameters:
networkSettings
- Network settings that connect the Nodes in the Cluster to one or more of the Networks that the Cluster is associated with.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
networkSettings
default DescribeClusterSummary.Builder networkSettings(Consumer<ClusterNetworkSettings.Builder> networkSettings) Network settings that connect the Nodes in the Cluster to one or more of the Networks that the Cluster is associated with. This is a convenience method that creates an instance of theClusterNetworkSettings.Builder
avoiding the need to create one manually viaClusterNetworkSettings.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tonetworkSettings(ClusterNetworkSettings)
.- Parameters:
networkSettings
- a consumer that will call methods onClusterNetworkSettings.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
state
The current state of the Cluster.- Parameters:
state
- The current state of the Cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
state
The current state of the Cluster.- Parameters:
state
- The current state of the Cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-