Interface ClusterMetadata.Builder

All Superinterfaces:
Buildable, CopyableBuilder<ClusterMetadata.Builder,ClusterMetadata>, SdkBuilder<ClusterMetadata.Builder,ClusterMetadata>, SdkPojo
Enclosing class:
ClusterMetadata

public static interface ClusterMetadata.Builder extends SdkPojo, CopyableBuilder<ClusterMetadata.Builder,ClusterMetadata>
  • Method Details

    • clusterId

      ClusterMetadata.Builder clusterId(String clusterId)

      The automatically generated ID for a cluster.

      Parameters:
      clusterId - The automatically generated ID for a cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • description

      ClusterMetadata.Builder description(String description)

      The optional description of the cluster.

      Parameters:
      description - The optional description of the cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • kmsKeyARN

      ClusterMetadata.Builder kmsKeyARN(String kmsKeyARN)

      The KmsKeyARN Amazon Resource Name (ARN) associated with this cluster. This ARN was created using the CreateKey API action in Key Management Service (KMS.

      Parameters:
      kmsKeyARN - The KmsKeyARN Amazon Resource Name (ARN) associated with this cluster. This ARN was created using the CreateKey API action in Key Management Service (KMS.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • roleARN

      ClusterMetadata.Builder roleARN(String roleARN)

      The role ARN associated with this cluster. This ARN was created using the CreateRole API action in Identity and Access Management (IAM).

      Parameters:
      roleARN - The role ARN associated with this cluster. This ARN was created using the CreateRole API action in Identity and Access Management (IAM).
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • clusterState

      ClusterMetadata.Builder clusterState(String clusterState)

      The current status of the cluster.

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

      ClusterMetadata.Builder clusterState(ClusterState clusterState)

      The current status of the cluster.

      Parameters:
      clusterState - The current status of the cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • jobType

      ClusterMetadata.Builder jobType(String jobType)

      The type of job for this cluster. Currently, the only job type supported for clusters is LOCAL_USE.

      Parameters:
      jobType - The type of job for this cluster. Currently, the only job type supported for clusters is LOCAL_USE.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • jobType

      ClusterMetadata.Builder jobType(JobType jobType)

      The type of job for this cluster. Currently, the only job type supported for clusters is LOCAL_USE.

      Parameters:
      jobType - The type of job for this cluster. Currently, the only job type supported for clusters is LOCAL_USE.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • snowballType

      ClusterMetadata.Builder snowballType(String snowballType)

      The type of Snowcone device to use for this cluster.

      For cluster jobs, Amazon Web Services Snow Family currently supports only the EDGE device type.

      Parameters:
      snowballType - The type of Snowcone device to use for this cluster.

      For cluster jobs, Amazon Web Services Snow Family currently supports only the EDGE device type.

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

      ClusterMetadata.Builder snowballType(SnowballType snowballType)

      The type of Snowcone device to use for this cluster.

      For cluster jobs, Amazon Web Services Snow Family currently supports only the EDGE device type.

      Parameters:
      snowballType - The type of Snowcone device to use for this cluster.

      For cluster jobs, Amazon Web Services Snow Family currently supports only the EDGE device type.

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

      ClusterMetadata.Builder creationDate(Instant creationDate)

      The creation date for this cluster.

      Parameters:
      creationDate - The creation date for this cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • resources

      ClusterMetadata.Builder resources(JobResource resources)

      The arrays of JobResource objects that can include updated S3Resource objects or LambdaResource objects.

      Parameters:
      resources - The arrays of JobResource objects that can include updated S3Resource objects or LambdaResource objects.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • resources

      default ClusterMetadata.Builder resources(Consumer<JobResource.Builder> resources)

      The arrays of JobResource objects that can include updated S3Resource objects or LambdaResource objects.

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

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

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

      ClusterMetadata.Builder addressId(String addressId)

      The automatically generated ID for a specific address.

      Parameters:
      addressId - The automatically generated ID for a specific address.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • shippingOption

      ClusterMetadata.Builder shippingOption(String shippingOption)

      The shipping speed for each node in this cluster. This speed doesn't dictate how soon you'll get each device, rather it represents how quickly each device moves to its destination while in transit. Regional shipping speeds are as follows:

      • In Australia, you have access to express shipping. Typically, devices shipped express are delivered in about a day.

      • In the European Union (EU), you have access to express shipping. Typically, Snow devices shipped express are delivered in about a day. In addition, most countries in the EU have access to standard shipping, which typically takes less than a week, one way.

      • In India, Snow devices are delivered in one to seven days.

      • In the US, you have access to one-day shipping and two-day shipping.

      Parameters:
      shippingOption - The shipping speed for each node in this cluster. This speed doesn't dictate how soon you'll get each device, rather it represents how quickly each device moves to its destination while in transit. Regional shipping speeds are as follows:

      • In Australia, you have access to express shipping. Typically, devices shipped express are delivered in about a day.

      • In the European Union (EU), you have access to express shipping. Typically, Snow devices shipped express are delivered in about a day. In addition, most countries in the EU have access to standard shipping, which typically takes less than a week, one way.

      • In India, Snow devices are delivered in one to seven days.

      • In the US, you have access to one-day shipping and two-day shipping.

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

      ClusterMetadata.Builder shippingOption(ShippingOption shippingOption)

      The shipping speed for each node in this cluster. This speed doesn't dictate how soon you'll get each device, rather it represents how quickly each device moves to its destination while in transit. Regional shipping speeds are as follows:

      • In Australia, you have access to express shipping. Typically, devices shipped express are delivered in about a day.

      • In the European Union (EU), you have access to express shipping. Typically, Snow devices shipped express are delivered in about a day. In addition, most countries in the EU have access to standard shipping, which typically takes less than a week, one way.

      • In India, Snow devices are delivered in one to seven days.

      • In the US, you have access to one-day shipping and two-day shipping.

      Parameters:
      shippingOption - The shipping speed for each node in this cluster. This speed doesn't dictate how soon you'll get each device, rather it represents how quickly each device moves to its destination while in transit. Regional shipping speeds are as follows:

      • In Australia, you have access to express shipping. Typically, devices shipped express are delivered in about a day.

      • In the European Union (EU), you have access to express shipping. Typically, Snow devices shipped express are delivered in about a day. In addition, most countries in the EU have access to standard shipping, which typically takes less than a week, one way.

      • In India, Snow devices are delivered in one to seven days.

      • In the US, you have access to one-day shipping and two-day shipping.

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

      ClusterMetadata.Builder notification(Notification notification)

      The Amazon Simple Notification Service (Amazon SNS) notification settings for this cluster.

      Parameters:
      notification - The Amazon Simple Notification Service (Amazon SNS) notification settings for this cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • notification

      default ClusterMetadata.Builder notification(Consumer<Notification.Builder> notification)

      The Amazon Simple Notification Service (Amazon SNS) notification settings for this cluster.

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

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

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

      ClusterMetadata.Builder forwardingAddressId(String forwardingAddressId)

      The ID of the address that you want a cluster shipped to, after it will be shipped to its primary address. This field is not supported in most regions.

      Parameters:
      forwardingAddressId - The ID of the address that you want a cluster shipped to, after it will be shipped to its primary address. This field is not supported in most regions.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • taxDocuments

      ClusterMetadata.Builder taxDocuments(TaxDocuments taxDocuments)

      The tax documents required in your Amazon Web Services Region.

      Parameters:
      taxDocuments - The tax documents required in your Amazon Web Services Region.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • taxDocuments

      default ClusterMetadata.Builder taxDocuments(Consumer<TaxDocuments.Builder> taxDocuments)

      The tax documents required in your Amazon Web Services Region.

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

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

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

      ClusterMetadata.Builder onDeviceServiceConfiguration(OnDeviceServiceConfiguration onDeviceServiceConfiguration)

      Represents metadata and configuration settings for services on an Amazon Web Services Snow Family device.

      Parameters:
      onDeviceServiceConfiguration - Represents metadata and configuration settings for services on an Amazon Web Services Snow Family device.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • onDeviceServiceConfiguration

      default ClusterMetadata.Builder onDeviceServiceConfiguration(Consumer<OnDeviceServiceConfiguration.Builder> onDeviceServiceConfiguration)

      Represents metadata and configuration settings for services on an Amazon Web Services Snow Family device.

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

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

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