Package software.amazon.awssdk.services.snowball.model

Interface CreateClusterRequest.Builder

    • Method Detail

      • jobType

        CreateClusterRequest.Builder jobType​(String jobType)

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

        For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide.

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

        For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide.

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

      • jobType

        CreateClusterRequest.Builder jobType​(JobType jobType)

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

        For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide.

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

        For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide.

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

      • resources

        CreateClusterRequest.Builder resources​(JobResource resources)

        The resources associated with the cluster job. These resources include Amazon S3 buckets and optional Lambda functions written in the Python language.

        Parameters:
        resources - The resources associated with the cluster job. These resources include Amazon S3 buckets and optional Lambda functions written in the Python language.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • onDeviceServiceConfiguration

        CreateClusterRequest.Builder onDeviceServiceConfiguration​(OnDeviceServiceConfiguration onDeviceServiceConfiguration)

        Specifies the service or services on the Snow Family device that your transferred data will be exported from or imported into. Amazon Web Services Snow Family device clusters support Amazon S3 and NFS (Network File System).

        Parameters:
        onDeviceServiceConfiguration - Specifies the service or services on the Snow Family device that your transferred data will be exported from or imported into. Amazon Web Services Snow Family device clusters support Amazon S3 and NFS (Network File System).
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • description

        CreateClusterRequest.Builder description​(String description)

        An optional description of this specific cluster, for example Environmental Data Cluster-01.

        Parameters:
        description - An optional description of this specific cluster, for example Environmental Data Cluster-01.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • addressId

        CreateClusterRequest.Builder addressId​(String addressId)

        The ID for the address that you want the cluster shipped to.

        Parameters:
        addressId - The ID for the address that you want the cluster shipped to.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • kmsKeyARN

        CreateClusterRequest.Builder kmsKeyARN​(String kmsKeyARN)

        The KmsKeyARN value that you want to associate with this cluster. KmsKeyARN values are created by using the CreateKey API action in Key Management Service (KMS).

        Parameters:
        kmsKeyARN - The KmsKeyARN value that you want to associate with this cluster. KmsKeyARN values are created by 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

        CreateClusterRequest.Builder roleARN​(String roleARN)

        The RoleARN that you want to associate with this cluster. RoleArn values are created by using the CreateRole API action in Identity and Access Management (IAM).

        Parameters:
        roleARN - The RoleARN that you want to associate with this cluster. RoleArn values are created by 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.

      • snowballType

        CreateClusterRequest.Builder snowballType​(String snowballType)

        The type of Snow Family devices to use for this cluster.

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

        For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide.

        Parameters:
        snowballType - The type of Snow Family devices to use for this cluster.

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

        For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide.

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

      • snowballType

        CreateClusterRequest.Builder snowballType​(SnowballType snowballType)

        The type of Snow Family devices to use for this cluster.

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

        For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide.

        Parameters:
        snowballType - The type of Snow Family devices to use for this cluster.

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

        For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide.

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

      • shippingOption

        CreateClusterRequest.Builder shippingOption​(String shippingOption)

        The shipping speed for each node in this cluster. This speed doesn't dictate how soon you'll get each Snowball Edge 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, Snow 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 United States of America (US), you have access to one-day shipping and two-day shipping.

        • 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 Snowball Edge 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, Snow 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 United States of America (US), you have access to one-day shipping and two-day shipping.

        • 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, ShippingOption

      • shippingOption

        CreateClusterRequest.Builder shippingOption​(ShippingOption shippingOption)

        The shipping speed for each node in this cluster. This speed doesn't dictate how soon you'll get each Snowball Edge 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, Snow 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 United States of America (US), you have access to one-day shipping and two-day shipping.

        • 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 Snowball Edge 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, Snow 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 United States of America (US), you have access to one-day shipping and two-day shipping.

        • 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, ShippingOption

      • notification

        CreateClusterRequest.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.

      • forwardingAddressId

        CreateClusterRequest.Builder forwardingAddressId​(String forwardingAddressId)

        The forwarding address ID for a cluster. This field is not supported in most regions.

        Parameters:
        forwardingAddressId - The forwarding address ID for a cluster. This field is not supported in most regions.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • taxDocuments

        CreateClusterRequest.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.

      • remoteManagement

        CreateClusterRequest.Builder remoteManagement​(String remoteManagement)

        Allows you to securely operate and manage Snow devices in a cluster remotely from outside of your internal network. When set to INSTALLED_AUTOSTART, remote management will automatically be available when the device arrives at your location. Otherwise, you need to use the Snowball Client to manage the device.

        Parameters:
        remoteManagement - Allows you to securely operate and manage Snow devices in a cluster remotely from outside of your internal network. When set to INSTALLED_AUTOSTART, remote management will automatically be available when the device arrives at your location. Otherwise, you need to use the Snowball Client to manage the device.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        RemoteManagement, RemoteManagement

      • remoteManagement

        CreateClusterRequest.Builder remoteManagement​(RemoteManagement remoteManagement)

        Allows you to securely operate and manage Snow devices in a cluster remotely from outside of your internal network. When set to INSTALLED_AUTOSTART, remote management will automatically be available when the device arrives at your location. Otherwise, you need to use the Snowball Client to manage the device.

        Parameters:
        remoteManagement - Allows you to securely operate and manage Snow devices in a cluster remotely from outside of your internal network. When set to INSTALLED_AUTOSTART, remote management will automatically be available when the device arrives at your location. Otherwise, you need to use the Snowball Client to manage the device.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        RemoteManagement, RemoteManagement

      • initialClusterSize

        CreateClusterRequest.Builder initialClusterSize​(Integer initialClusterSize)

        If provided, each job will be automatically created and associated with the new cluster. If not provided, will be treated as 0.

        Parameters:
        initialClusterSize - If provided, each job will be automatically created and associated with the new cluster. If not provided, will be treated as 0.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • forceCreateJobs

        CreateClusterRequest.Builder forceCreateJobs​(Boolean forceCreateJobs)

        Force to create cluster when user attempts to overprovision or underprovision a cluster. A cluster is overprovisioned or underprovisioned if the initial size of the cluster is more (overprovisioned) or less (underprovisioned) than what needed to meet capacity requirement specified with OnDeviceServiceConfiguration.

        Parameters:
        forceCreateJobs - Force to create cluster when user attempts to overprovision or underprovision a cluster. A cluster is overprovisioned or underprovisioned if the initial size of the cluster is more (overprovisioned) or less (underprovisioned) than what needed to meet capacity requirement specified with OnDeviceServiceConfiguration.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • longTermPricingIds

        CreateClusterRequest.Builder longTermPricingIds​(Collection<String> longTermPricingIds)

        Lists long-term pricing id that will be used to associate with jobs automatically created for the new cluster.

        Parameters:
        longTermPricingIds - Lists long-term pricing id that will be used to associate with jobs automatically created for the new cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • longTermPricingIds

        CreateClusterRequest.Builder longTermPricingIds​(String... longTermPricingIds)

        Lists long-term pricing id that will be used to associate with jobs automatically created for the new cluster.

        Parameters:
        longTermPricingIds - Lists long-term pricing id that will be used to associate with jobs automatically created for the new cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • snowballCapacityPreference

        CreateClusterRequest.Builder snowballCapacityPreference​(String snowballCapacityPreference)

        If your job is being created in one of the US regions, you have the option of specifying what size Snow device you'd like for this job. In all other regions, Snowballs come with 80 TB in storage capacity.

        For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide.

        Parameters:
        snowballCapacityPreference - If your job is being created in one of the US regions, you have the option of specifying what size Snow device you'd like for this job. In all other regions, Snowballs come with 80 TB in storage capacity.

        For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide.

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

      • snowballCapacityPreference

        CreateClusterRequest.Builder snowballCapacityPreference​(SnowballCapacity snowballCapacityPreference)

        If your job is being created in one of the US regions, you have the option of specifying what size Snow device you'd like for this job. In all other regions, Snowballs come with 80 TB in storage capacity.

        For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide.

        Parameters:
        snowballCapacityPreference - If your job is being created in one of the US regions, you have the option of specifying what size Snow device you'd like for this job. In all other regions, Snowballs come with 80 TB in storage capacity.

        For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide.

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