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

Class CreateClusterRequest

    • Method Detail

      • jobType

        public final 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.

        If the service returns an enum value that is not available in the current SDK version, jobType will return JobType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from jobTypeAsString().

        Returns:
        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.

        See Also:
        JobType

      • jobTypeAsString

        public final String jobTypeAsString()

        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.

        If the service returns an enum value that is not available in the current SDK version, jobType will return JobType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from jobTypeAsString().

        Returns:
        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.

        See Also:
        JobType

      • resources

        public final JobResource resources()

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

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

      • onDeviceServiceConfiguration

        public final 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).

        Returns:
        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).

      • description

        public final String description()

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

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

      • addressId

        public final String addressId()

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

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

      • kmsKeyARN

        public final 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).

        Returns:
        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).

      • roleARN

        public final 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).

        Returns:
        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).

      • snowballType

        public final 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.

        If the service returns an enum value that is not available in the current SDK version, snowballType will return SnowballType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from snowballTypeAsString().

        Returns:
        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.

        See Also:
        SnowballType

      • snowballTypeAsString

        public final String snowballTypeAsString()

        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.

        If the service returns an enum value that is not available in the current SDK version, snowballType will return SnowballType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from snowballTypeAsString().

        Returns:
        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.

        See Also:
        SnowballType

      • shippingOption

        public final 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.

        If the service returns an enum value that is not available in the current SDK version, shippingOption will return ShippingOption.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from shippingOptionAsString().

        Returns:
        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.

        See Also:
        ShippingOption

      • shippingOptionAsString

        public final String shippingOptionAsString()

        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.

        If the service returns an enum value that is not available in the current SDK version, shippingOption will return ShippingOption.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from shippingOptionAsString().

        Returns:
        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.

        See Also:
        ShippingOption

      • notification

        public final Notification notification()

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

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

      • forwardingAddressId

        public final String forwardingAddressId()

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

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

      • taxDocuments

        public final TaxDocuments taxDocuments()

        The tax documents required in your Amazon Web Services Region.

        Returns:
        The tax documents required in your Amazon Web Services Region.

      • remoteManagement

        public final 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.

        If the service returns an enum value that is not available in the current SDK version, remoteManagement will return RemoteManagement.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from remoteManagementAsString().

        Returns:
        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.
        See Also:
        RemoteManagement

      • remoteManagementAsString

        public final String remoteManagementAsString()

        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.

        If the service returns an enum value that is not available in the current SDK version, remoteManagement will return RemoteManagement.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from remoteManagementAsString().

        Returns:
        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.
        See Also:
        RemoteManagement

      • initialClusterSize

        public final Integer initialClusterSize()

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

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

      • forceCreateJobs

        public final 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.

        Returns:
        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.

      • hasLongTermPricingIds

        public final boolean hasLongTermPricingIds()
        For responses, this returns true if the service returned a value for the LongTermPricingIds property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • longTermPricingIds

        public final List<String> longTermPricingIds()

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

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasLongTermPricingIds() method.

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

      • snowballCapacityPreference

        public final 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.

        If the service returns an enum value that is not available in the current SDK version, snowballCapacityPreference will return SnowballCapacity.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from snowballCapacityPreferenceAsString().

        Returns:
        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.

        See Also:
        SnowballCapacity

      • snowballCapacityPreferenceAsString

        public final String snowballCapacityPreferenceAsString()

        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.

        If the service returns an enum value that is not available in the current SDK version, snowballCapacityPreference will return SnowballCapacity.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from snowballCapacityPreferenceAsString().

        Returns:
        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.

        See Also:
        SnowballCapacity

      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object