/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include #include #include #include #include #include namespace Aws { namespace Utils { namespace Json { class JsonValue; class JsonView; } // namespace Json } // namespace Utils namespace Snowball { namespace Model { /** *

Contains metadata about a specific cluster.

See Also:

AWS * API Reference

*/ class AWS_SNOWBALL_API ClusterMetadata { public: ClusterMetadata(); ClusterMetadata(Aws::Utils::Json::JsonView jsonValue); ClusterMetadata& operator=(Aws::Utils::Json::JsonView jsonValue); Aws::Utils::Json::JsonValue Jsonize() const; /** *

The automatically generated ID for a cluster.

*/ inline const Aws::String& GetClusterId() const{ return m_clusterId; } /** *

The automatically generated ID for a cluster.

*/ inline bool ClusterIdHasBeenSet() const { return m_clusterIdHasBeenSet; } /** *

The automatically generated ID for a cluster.

*/ inline void SetClusterId(const Aws::String& value) { m_clusterIdHasBeenSet = true; m_clusterId = value; } /** *

The automatically generated ID for a cluster.

*/ inline void SetClusterId(Aws::String&& value) { m_clusterIdHasBeenSet = true; m_clusterId = std::move(value); } /** *

The automatically generated ID for a cluster.

*/ inline void SetClusterId(const char* value) { m_clusterIdHasBeenSet = true; m_clusterId.assign(value); } /** *

The automatically generated ID for a cluster.

*/ inline ClusterMetadata& WithClusterId(const Aws::String& value) { SetClusterId(value); return *this;} /** *

The automatically generated ID for a cluster.

*/ inline ClusterMetadata& WithClusterId(Aws::String&& value) { SetClusterId(std::move(value)); return *this;} /** *

The automatically generated ID for a cluster.

*/ inline ClusterMetadata& WithClusterId(const char* value) { SetClusterId(value); return *this;} /** *

The optional description of the cluster.

*/ inline const Aws::String& GetDescription() const{ return m_description; } /** *

The optional description of the cluster.

*/ inline bool DescriptionHasBeenSet() const { return m_descriptionHasBeenSet; } /** *

The optional description of the cluster.

*/ inline void SetDescription(const Aws::String& value) { m_descriptionHasBeenSet = true; m_description = value; } /** *

The optional description of the cluster.

*/ inline void SetDescription(Aws::String&& value) { m_descriptionHasBeenSet = true; m_description = std::move(value); } /** *

The optional description of the cluster.

*/ inline void SetDescription(const char* value) { m_descriptionHasBeenSet = true; m_description.assign(value); } /** *

The optional description of the cluster.

*/ inline ClusterMetadata& WithDescription(const Aws::String& value) { SetDescription(value); return *this;} /** *

The optional description of the cluster.

*/ inline ClusterMetadata& WithDescription(Aws::String&& value) { SetDescription(std::move(value)); return *this;} /** *

The optional description of the cluster.

*/ inline ClusterMetadata& WithDescription(const char* value) { SetDescription(value); return *this;} /** *

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

*/ inline const Aws::String& GetKmsKeyARN() const{ return m_kmsKeyARN; } /** *

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

*/ inline bool KmsKeyARNHasBeenSet() const { return m_kmsKeyARNHasBeenSet; } /** *

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

*/ inline void SetKmsKeyARN(const Aws::String& value) { m_kmsKeyARNHasBeenSet = true; m_kmsKeyARN = value; } /** *

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

*/ inline void SetKmsKeyARN(Aws::String&& value) { m_kmsKeyARNHasBeenSet = true; m_kmsKeyARN = std::move(value); } /** *

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

*/ inline void SetKmsKeyARN(const char* value) { m_kmsKeyARNHasBeenSet = true; m_kmsKeyARN.assign(value); } /** *

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

*/ inline ClusterMetadata& WithKmsKeyARN(const Aws::String& value) { SetKmsKeyARN(value); return *this;} /** *

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

*/ inline ClusterMetadata& WithKmsKeyARN(Aws::String&& value) { SetKmsKeyARN(std::move(value)); return *this;} /** *

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

*/ inline ClusterMetadata& WithKmsKeyARN(const char* value) { SetKmsKeyARN(value); return *this;} /** *

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

*/ inline const Aws::String& GetRoleARN() const{ return m_roleARN; } /** *

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

*/ inline bool RoleARNHasBeenSet() const { return m_roleARNHasBeenSet; } /** *

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

*/ inline void SetRoleARN(const Aws::String& value) { m_roleARNHasBeenSet = true; m_roleARN = value; } /** *

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

*/ inline void SetRoleARN(Aws::String&& value) { m_roleARNHasBeenSet = true; m_roleARN = std::move(value); } /** *

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

*/ inline void SetRoleARN(const char* value) { m_roleARNHasBeenSet = true; m_roleARN.assign(value); } /** *

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

*/ inline ClusterMetadata& WithRoleARN(const Aws::String& value) { SetRoleARN(value); return *this;} /** *

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

*/ inline ClusterMetadata& WithRoleARN(Aws::String&& value) { SetRoleARN(std::move(value)); return *this;} /** *

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

*/ inline ClusterMetadata& WithRoleARN(const char* value) { SetRoleARN(value); return *this;} /** *

The current status of the cluster.

*/ inline const ClusterState& GetClusterState() const{ return m_clusterState; } /** *

The current status of the cluster.

*/ inline bool ClusterStateHasBeenSet() const { return m_clusterStateHasBeenSet; } /** *

The current status of the cluster.

*/ inline void SetClusterState(const ClusterState& value) { m_clusterStateHasBeenSet = true; m_clusterState = value; } /** *

The current status of the cluster.

*/ inline void SetClusterState(ClusterState&& value) { m_clusterStateHasBeenSet = true; m_clusterState = std::move(value); } /** *

The current status of the cluster.

*/ inline ClusterMetadata& WithClusterState(const ClusterState& value) { SetClusterState(value); return *this;} /** *

The current status of the cluster.

*/ inline ClusterMetadata& WithClusterState(ClusterState&& value) { SetClusterState(std::move(value)); return *this;} /** *

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

*/ inline const JobType& GetJobType() const{ return m_jobType; } /** *

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

*/ inline bool JobTypeHasBeenSet() const { return m_jobTypeHasBeenSet; } /** *

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

*/ inline void SetJobType(const JobType& value) { m_jobTypeHasBeenSet = true; m_jobType = value; } /** *

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

*/ inline void SetJobType(JobType&& value) { m_jobTypeHasBeenSet = true; m_jobType = std::move(value); } /** *

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

*/ inline ClusterMetadata& WithJobType(const JobType& value) { SetJobType(value); return *this;} /** *

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

*/ inline ClusterMetadata& WithJobType(JobType&& value) { SetJobType(std::move(value)); return *this;} /** *

The type of AWS Snowball device to use for this cluster.

For * cluster jobs, AWS Snowball currently supports only the EDGE device * type.

*/ inline const SnowballType& GetSnowballType() const{ return m_snowballType; } /** *

The type of AWS Snowball device to use for this cluster.

For * cluster jobs, AWS Snowball currently supports only the EDGE device * type.

*/ inline bool SnowballTypeHasBeenSet() const { return m_snowballTypeHasBeenSet; } /** *

The type of AWS Snowball device to use for this cluster.

For * cluster jobs, AWS Snowball currently supports only the EDGE device * type.

*/ inline void SetSnowballType(const SnowballType& value) { m_snowballTypeHasBeenSet = true; m_snowballType = value; } /** *

The type of AWS Snowball device to use for this cluster.

For * cluster jobs, AWS Snowball currently supports only the EDGE device * type.

*/ inline void SetSnowballType(SnowballType&& value) { m_snowballTypeHasBeenSet = true; m_snowballType = std::move(value); } /** *

The type of AWS Snowball device to use for this cluster.

For * cluster jobs, AWS Snowball currently supports only the EDGE device * type.

*/ inline ClusterMetadata& WithSnowballType(const SnowballType& value) { SetSnowballType(value); return *this;} /** *

The type of AWS Snowball device to use for this cluster.

For * cluster jobs, AWS Snowball currently supports only the EDGE device * type.

*/ inline ClusterMetadata& WithSnowballType(SnowballType&& value) { SetSnowballType(std::move(value)); return *this;} /** *

The creation date for this cluster.

*/ inline const Aws::Utils::DateTime& GetCreationDate() const{ return m_creationDate; } /** *

The creation date for this cluster.

*/ inline bool CreationDateHasBeenSet() const { return m_creationDateHasBeenSet; } /** *

The creation date for this cluster.

*/ inline void SetCreationDate(const Aws::Utils::DateTime& value) { m_creationDateHasBeenSet = true; m_creationDate = value; } /** *

The creation date for this cluster.

*/ inline void SetCreationDate(Aws::Utils::DateTime&& value) { m_creationDateHasBeenSet = true; m_creationDate = std::move(value); } /** *

The creation date for this cluster.

*/ inline ClusterMetadata& WithCreationDate(const Aws::Utils::DateTime& value) { SetCreationDate(value); return *this;} /** *

The creation date for this cluster.

*/ inline ClusterMetadata& WithCreationDate(Aws::Utils::DateTime&& value) { SetCreationDate(std::move(value)); return *this;} /** *

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

*/ inline const JobResource& GetResources() const{ return m_resources; } /** *

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

*/ inline bool ResourcesHasBeenSet() const { return m_resourcesHasBeenSet; } /** *

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

*/ inline void SetResources(const JobResource& value) { m_resourcesHasBeenSet = true; m_resources = value; } /** *

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

*/ inline void SetResources(JobResource&& value) { m_resourcesHasBeenSet = true; m_resources = std::move(value); } /** *

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

*/ inline ClusterMetadata& WithResources(const JobResource& value) { SetResources(value); return *this;} /** *

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

*/ inline ClusterMetadata& WithResources(JobResource&& value) { SetResources(std::move(value)); return *this;} /** *

The automatically generated ID for a specific address.

*/ inline const Aws::String& GetAddressId() const{ return m_addressId; } /** *

The automatically generated ID for a specific address.

*/ inline bool AddressIdHasBeenSet() const { return m_addressIdHasBeenSet; } /** *

The automatically generated ID for a specific address.

*/ inline void SetAddressId(const Aws::String& value) { m_addressIdHasBeenSet = true; m_addressId = value; } /** *

The automatically generated ID for a specific address.

*/ inline void SetAddressId(Aws::String&& value) { m_addressIdHasBeenSet = true; m_addressId = std::move(value); } /** *

The automatically generated ID for a specific address.

*/ inline void SetAddressId(const char* value) { m_addressIdHasBeenSet = true; m_addressId.assign(value); } /** *

The automatically generated ID for a specific address.

*/ inline ClusterMetadata& WithAddressId(const Aws::String& value) { SetAddressId(value); return *this;} /** *

The automatically generated ID for a specific address.

*/ inline ClusterMetadata& WithAddressId(Aws::String&& value) { SetAddressId(std::move(value)); return *this;} /** *

The automatically generated ID for a specific address.

*/ inline ClusterMetadata& WithAddressId(const char* value) { SetAddressId(value); return *this;} /** *

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, devices shipped express are delivered in about a day.

    *
  • In the European Union (EU), you have access to express shipping. * Typically, Snowball Edges 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, Snowball * Edges are delivered in one to seven days.

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

*/ inline const ShippingOption& GetShippingOption() const{ return m_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, devices shipped express are delivered in about a day.

    *
  • In the European Union (EU), you have access to express shipping. * Typically, Snowball Edges 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, Snowball * Edges are delivered in one to seven days.

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

*/ inline bool ShippingOptionHasBeenSet() const { return m_shippingOptionHasBeenSet; } /** *

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, devices shipped express are delivered in about a day.

    *
  • In the European Union (EU), you have access to express shipping. * Typically, Snowball Edges 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, Snowball * Edges are delivered in one to seven days.

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

*/ inline void SetShippingOption(const ShippingOption& value) { m_shippingOptionHasBeenSet = true; m_shippingOption = value; } /** *

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, devices shipped express are delivered in about a day.

    *
  • In the European Union (EU), you have access to express shipping. * Typically, Snowball Edges 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, Snowball * Edges are delivered in one to seven days.

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

*/ inline void SetShippingOption(ShippingOption&& value) { m_shippingOptionHasBeenSet = true; m_shippingOption = std::move(value); } /** *

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, devices shipped express are delivered in about a day.

    *
  • In the European Union (EU), you have access to express shipping. * Typically, Snowball Edges 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, Snowball * Edges are delivered in one to seven days.

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

*/ inline ClusterMetadata& WithShippingOption(const ShippingOption& value) { SetShippingOption(value); return *this;} /** *

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, devices shipped express are delivered in about a day.

    *
  • In the European Union (EU), you have access to express shipping. * Typically, Snowball Edges 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, Snowball * Edges are delivered in one to seven days.

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

*/ inline ClusterMetadata& WithShippingOption(ShippingOption&& value) { SetShippingOption(std::move(value)); return *this;} /** *

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

*/ inline const Notification& GetNotification() const{ return m_notification; } /** *

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

*/ inline bool NotificationHasBeenSet() const { return m_notificationHasBeenSet; } /** *

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

*/ inline void SetNotification(const Notification& value) { m_notificationHasBeenSet = true; m_notification = value; } /** *

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

*/ inline void SetNotification(Notification&& value) { m_notificationHasBeenSet = true; m_notification = std::move(value); } /** *

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

*/ inline ClusterMetadata& WithNotification(const Notification& value) { SetNotification(value); return *this;} /** *

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

*/ inline ClusterMetadata& WithNotification(Notification&& value) { SetNotification(std::move(value)); return *this;} /** *

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.

*/ inline const Aws::String& GetForwardingAddressId() const{ return m_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.

*/ inline bool ForwardingAddressIdHasBeenSet() const { return m_forwardingAddressIdHasBeenSet; } /** *

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.

*/ inline void SetForwardingAddressId(const Aws::String& value) { m_forwardingAddressIdHasBeenSet = true; m_forwardingAddressId = value; } /** *

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.

*/ inline void SetForwardingAddressId(Aws::String&& value) { m_forwardingAddressIdHasBeenSet = true; m_forwardingAddressId = std::move(value); } /** *

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.

*/ inline void SetForwardingAddressId(const char* value) { m_forwardingAddressIdHasBeenSet = true; m_forwardingAddressId.assign(value); } /** *

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.

*/ inline ClusterMetadata& WithForwardingAddressId(const Aws::String& value) { SetForwardingAddressId(value); return *this;} /** *

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.

*/ inline ClusterMetadata& WithForwardingAddressId(Aws::String&& value) { SetForwardingAddressId(std::move(value)); return *this;} /** *

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.

*/ inline ClusterMetadata& WithForwardingAddressId(const char* value) { SetForwardingAddressId(value); return *this;} /** *

The tax documents required in your AWS Region.

*/ inline const TaxDocuments& GetTaxDocuments() const{ return m_taxDocuments; } /** *

The tax documents required in your AWS Region.

*/ inline bool TaxDocumentsHasBeenSet() const { return m_taxDocumentsHasBeenSet; } /** *

The tax documents required in your AWS Region.

*/ inline void SetTaxDocuments(const TaxDocuments& value) { m_taxDocumentsHasBeenSet = true; m_taxDocuments = value; } /** *

The tax documents required in your AWS Region.

*/ inline void SetTaxDocuments(TaxDocuments&& value) { m_taxDocumentsHasBeenSet = true; m_taxDocuments = std::move(value); } /** *

The tax documents required in your AWS Region.

*/ inline ClusterMetadata& WithTaxDocuments(const TaxDocuments& value) { SetTaxDocuments(value); return *this;} /** *

The tax documents required in your AWS Region.

*/ inline ClusterMetadata& WithTaxDocuments(TaxDocuments&& value) { SetTaxDocuments(std::move(value)); return *this;} private: Aws::String m_clusterId; bool m_clusterIdHasBeenSet; Aws::String m_description; bool m_descriptionHasBeenSet; Aws::String m_kmsKeyARN; bool m_kmsKeyARNHasBeenSet; Aws::String m_roleARN; bool m_roleARNHasBeenSet; ClusterState m_clusterState; bool m_clusterStateHasBeenSet; JobType m_jobType; bool m_jobTypeHasBeenSet; SnowballType m_snowballType; bool m_snowballTypeHasBeenSet; Aws::Utils::DateTime m_creationDate; bool m_creationDateHasBeenSet; JobResource m_resources; bool m_resourcesHasBeenSet; Aws::String m_addressId; bool m_addressIdHasBeenSet; ShippingOption m_shippingOption; bool m_shippingOptionHasBeenSet; Notification m_notification; bool m_notificationHasBeenSet; Aws::String m_forwardingAddressId; bool m_forwardingAddressIdHasBeenSet; TaxDocuments m_taxDocuments; bool m_taxDocumentsHasBeenSet; }; } // namespace Model } // namespace Snowball } // namespace Aws