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

A resource that can be distributed to callers for executing Method resources * that require an API key. API keys can be mapped to any Stage on any RestApi, * which indicates that the callers with the API key can make requests to that * stage.

See Also:

AWS * API Reference

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

The identifier of the API Key.

*/ inline const Aws::String& GetId() const{ return m_id; } /** *

The identifier of the API Key.

*/ inline bool IdHasBeenSet() const { return m_idHasBeenSet; } /** *

The identifier of the API Key.

*/ inline void SetId(const Aws::String& value) { m_idHasBeenSet = true; m_id = value; } /** *

The identifier of the API Key.

*/ inline void SetId(Aws::String&& value) { m_idHasBeenSet = true; m_id = std::move(value); } /** *

The identifier of the API Key.

*/ inline void SetId(const char* value) { m_idHasBeenSet = true; m_id.assign(value); } /** *

The identifier of the API Key.

*/ inline ApiKey& WithId(const Aws::String& value) { SetId(value); return *this;} /** *

The identifier of the API Key.

*/ inline ApiKey& WithId(Aws::String&& value) { SetId(std::move(value)); return *this;} /** *

The identifier of the API Key.

*/ inline ApiKey& WithId(const char* value) { SetId(value); return *this;} /** *

The value of the API Key.

*/ inline const Aws::String& GetValue() const{ return m_value; } /** *

The value of the API Key.

*/ inline bool ValueHasBeenSet() const { return m_valueHasBeenSet; } /** *

The value of the API Key.

*/ inline void SetValue(const Aws::String& value) { m_valueHasBeenSet = true; m_value = value; } /** *

The value of the API Key.

*/ inline void SetValue(Aws::String&& value) { m_valueHasBeenSet = true; m_value = std::move(value); } /** *

The value of the API Key.

*/ inline void SetValue(const char* value) { m_valueHasBeenSet = true; m_value.assign(value); } /** *

The value of the API Key.

*/ inline ApiKey& WithValue(const Aws::String& value) { SetValue(value); return *this;} /** *

The value of the API Key.

*/ inline ApiKey& WithValue(Aws::String&& value) { SetValue(std::move(value)); return *this;} /** *

The value of the API Key.

*/ inline ApiKey& WithValue(const char* value) { SetValue(value); return *this;} /** *

The name of the API Key.

*/ inline const Aws::String& GetName() const{ return m_name; } /** *

The name of the API Key.

*/ inline bool NameHasBeenSet() const { return m_nameHasBeenSet; } /** *

The name of the API Key.

*/ inline void SetName(const Aws::String& value) { m_nameHasBeenSet = true; m_name = value; } /** *

The name of the API Key.

*/ inline void SetName(Aws::String&& value) { m_nameHasBeenSet = true; m_name = std::move(value); } /** *

The name of the API Key.

*/ inline void SetName(const char* value) { m_nameHasBeenSet = true; m_name.assign(value); } /** *

The name of the API Key.

*/ inline ApiKey& WithName(const Aws::String& value) { SetName(value); return *this;} /** *

The name of the API Key.

*/ inline ApiKey& WithName(Aws::String&& value) { SetName(std::move(value)); return *this;} /** *

The name of the API Key.

*/ inline ApiKey& WithName(const char* value) { SetName(value); return *this;} /** *

An AWS Marketplace customer identifier , when integrating with the AWS SaaS * Marketplace.

*/ inline const Aws::String& GetCustomerId() const{ return m_customerId; } /** *

An AWS Marketplace customer identifier , when integrating with the AWS SaaS * Marketplace.

*/ inline bool CustomerIdHasBeenSet() const { return m_customerIdHasBeenSet; } /** *

An AWS Marketplace customer identifier , when integrating with the AWS SaaS * Marketplace.

*/ inline void SetCustomerId(const Aws::String& value) { m_customerIdHasBeenSet = true; m_customerId = value; } /** *

An AWS Marketplace customer identifier , when integrating with the AWS SaaS * Marketplace.

*/ inline void SetCustomerId(Aws::String&& value) { m_customerIdHasBeenSet = true; m_customerId = std::move(value); } /** *

An AWS Marketplace customer identifier , when integrating with the AWS SaaS * Marketplace.

*/ inline void SetCustomerId(const char* value) { m_customerIdHasBeenSet = true; m_customerId.assign(value); } /** *

An AWS Marketplace customer identifier , when integrating with the AWS SaaS * Marketplace.

*/ inline ApiKey& WithCustomerId(const Aws::String& value) { SetCustomerId(value); return *this;} /** *

An AWS Marketplace customer identifier , when integrating with the AWS SaaS * Marketplace.

*/ inline ApiKey& WithCustomerId(Aws::String&& value) { SetCustomerId(std::move(value)); return *this;} /** *

An AWS Marketplace customer identifier , when integrating with the AWS SaaS * Marketplace.

*/ inline ApiKey& WithCustomerId(const char* value) { SetCustomerId(value); return *this;} /** *

The description of the API Key.

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

The description of the API Key.

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

The description of the API Key.

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

The description of the API Key.

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

The description of the API Key.

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

The description of the API Key.

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

The description of the API Key.

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

The description of the API Key.

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

Specifies whether the API Key can be used by callers.

*/ inline bool GetEnabled() const{ return m_enabled; } /** *

Specifies whether the API Key can be used by callers.

*/ inline bool EnabledHasBeenSet() const { return m_enabledHasBeenSet; } /** *

Specifies whether the API Key can be used by callers.

*/ inline void SetEnabled(bool value) { m_enabledHasBeenSet = true; m_enabled = value; } /** *

Specifies whether the API Key can be used by callers.

*/ inline ApiKey& WithEnabled(bool value) { SetEnabled(value); return *this;} /** *

The timestamp when the API Key was created.

*/ inline const Aws::Utils::DateTime& GetCreatedDate() const{ return m_createdDate; } /** *

The timestamp when the API Key was created.

*/ inline bool CreatedDateHasBeenSet() const { return m_createdDateHasBeenSet; } /** *

The timestamp when the API Key was created.

*/ inline void SetCreatedDate(const Aws::Utils::DateTime& value) { m_createdDateHasBeenSet = true; m_createdDate = value; } /** *

The timestamp when the API Key was created.

*/ inline void SetCreatedDate(Aws::Utils::DateTime&& value) { m_createdDateHasBeenSet = true; m_createdDate = std::move(value); } /** *

The timestamp when the API Key was created.

*/ inline ApiKey& WithCreatedDate(const Aws::Utils::DateTime& value) { SetCreatedDate(value); return *this;} /** *

The timestamp when the API Key was created.

*/ inline ApiKey& WithCreatedDate(Aws::Utils::DateTime&& value) { SetCreatedDate(std::move(value)); return *this;} /** *

The timestamp when the API Key was last updated.

*/ inline const Aws::Utils::DateTime& GetLastUpdatedDate() const{ return m_lastUpdatedDate; } /** *

The timestamp when the API Key was last updated.

*/ inline bool LastUpdatedDateHasBeenSet() const { return m_lastUpdatedDateHasBeenSet; } /** *

The timestamp when the API Key was last updated.

*/ inline void SetLastUpdatedDate(const Aws::Utils::DateTime& value) { m_lastUpdatedDateHasBeenSet = true; m_lastUpdatedDate = value; } /** *

The timestamp when the API Key was last updated.

*/ inline void SetLastUpdatedDate(Aws::Utils::DateTime&& value) { m_lastUpdatedDateHasBeenSet = true; m_lastUpdatedDate = std::move(value); } /** *

The timestamp when the API Key was last updated.

*/ inline ApiKey& WithLastUpdatedDate(const Aws::Utils::DateTime& value) { SetLastUpdatedDate(value); return *this;} /** *

The timestamp when the API Key was last updated.

*/ inline ApiKey& WithLastUpdatedDate(Aws::Utils::DateTime&& value) { SetLastUpdatedDate(std::move(value)); return *this;} /** *

A list of Stage resources that are associated with the ApiKey resource.

*/ inline const Aws::Vector& GetStageKeys() const{ return m_stageKeys; } /** *

A list of Stage resources that are associated with the ApiKey resource.

*/ inline bool StageKeysHasBeenSet() const { return m_stageKeysHasBeenSet; } /** *

A list of Stage resources that are associated with the ApiKey resource.

*/ inline void SetStageKeys(const Aws::Vector& value) { m_stageKeysHasBeenSet = true; m_stageKeys = value; } /** *

A list of Stage resources that are associated with the ApiKey resource.

*/ inline void SetStageKeys(Aws::Vector&& value) { m_stageKeysHasBeenSet = true; m_stageKeys = std::move(value); } /** *

A list of Stage resources that are associated with the ApiKey resource.

*/ inline ApiKey& WithStageKeys(const Aws::Vector& value) { SetStageKeys(value); return *this;} /** *

A list of Stage resources that are associated with the ApiKey resource.

*/ inline ApiKey& WithStageKeys(Aws::Vector&& value) { SetStageKeys(std::move(value)); return *this;} /** *

A list of Stage resources that are associated with the ApiKey resource.

*/ inline ApiKey& AddStageKeys(const Aws::String& value) { m_stageKeysHasBeenSet = true; m_stageKeys.push_back(value); return *this; } /** *

A list of Stage resources that are associated with the ApiKey resource.

*/ inline ApiKey& AddStageKeys(Aws::String&& value) { m_stageKeysHasBeenSet = true; m_stageKeys.push_back(std::move(value)); return *this; } /** *

A list of Stage resources that are associated with the ApiKey resource.

*/ inline ApiKey& AddStageKeys(const char* value) { m_stageKeysHasBeenSet = true; m_stageKeys.push_back(value); return *this; } /** *

The collection of tags. Each tag element is associated with a given * resource.

*/ inline const Aws::Map& GetTags() const{ return m_tags; } /** *

The collection of tags. Each tag element is associated with a given * resource.

*/ inline bool TagsHasBeenSet() const { return m_tagsHasBeenSet; } /** *

The collection of tags. Each tag element is associated with a given * resource.

*/ inline void SetTags(const Aws::Map& value) { m_tagsHasBeenSet = true; m_tags = value; } /** *

The collection of tags. Each tag element is associated with a given * resource.

*/ inline void SetTags(Aws::Map&& value) { m_tagsHasBeenSet = true; m_tags = std::move(value); } /** *

The collection of tags. Each tag element is associated with a given * resource.

*/ inline ApiKey& WithTags(const Aws::Map& value) { SetTags(value); return *this;} /** *

The collection of tags. Each tag element is associated with a given * resource.

*/ inline ApiKey& WithTags(Aws::Map&& value) { SetTags(std::move(value)); return *this;} /** *

The collection of tags. Each tag element is associated with a given * resource.

*/ inline ApiKey& AddTags(const Aws::String& key, const Aws::String& value) { m_tagsHasBeenSet = true; m_tags.emplace(key, value); return *this; } /** *

The collection of tags. Each tag element is associated with a given * resource.

*/ inline ApiKey& AddTags(Aws::String&& key, const Aws::String& value) { m_tagsHasBeenSet = true; m_tags.emplace(std::move(key), value); return *this; } /** *

The collection of tags. Each tag element is associated with a given * resource.

*/ inline ApiKey& AddTags(const Aws::String& key, Aws::String&& value) { m_tagsHasBeenSet = true; m_tags.emplace(key, std::move(value)); return *this; } /** *

The collection of tags. Each tag element is associated with a given * resource.

*/ inline ApiKey& AddTags(Aws::String&& key, Aws::String&& value) { m_tagsHasBeenSet = true; m_tags.emplace(std::move(key), std::move(value)); return *this; } /** *

The collection of tags. Each tag element is associated with a given * resource.

*/ inline ApiKey& AddTags(const char* key, Aws::String&& value) { m_tagsHasBeenSet = true; m_tags.emplace(key, std::move(value)); return *this; } /** *

The collection of tags. Each tag element is associated with a given * resource.

*/ inline ApiKey& AddTags(Aws::String&& key, const char* value) { m_tagsHasBeenSet = true; m_tags.emplace(std::move(key), value); return *this; } /** *

The collection of tags. Each tag element is associated with a given * resource.

*/ inline ApiKey& AddTags(const char* key, const char* value) { m_tagsHasBeenSet = true; m_tags.emplace(key, value); return *this; } inline const Aws::String& GetRequestId() const{ return m_requestId; } inline bool RequestIdHasBeenSet() const { return m_requestIdHasBeenSet; } inline void SetRequestId(const Aws::String& value) { m_requestIdHasBeenSet = true; m_requestId = value; } inline void SetRequestId(Aws::String&& value) { m_requestIdHasBeenSet = true; m_requestId = std::move(value); } inline void SetRequestId(const char* value) { m_requestIdHasBeenSet = true; m_requestId.assign(value); } inline ApiKey& WithRequestId(const Aws::String& value) { SetRequestId(value); return *this;} inline ApiKey& WithRequestId(Aws::String&& value) { SetRequestId(std::move(value)); return *this;} inline ApiKey& WithRequestId(const char* value) { SetRequestId(value); return *this;} private: Aws::String m_id; bool m_idHasBeenSet = false; Aws::String m_value; bool m_valueHasBeenSet = false; Aws::String m_name; bool m_nameHasBeenSet = false; Aws::String m_customerId; bool m_customerIdHasBeenSet = false; Aws::String m_description; bool m_descriptionHasBeenSet = false; bool m_enabled; bool m_enabledHasBeenSet = false; Aws::Utils::DateTime m_createdDate; bool m_createdDateHasBeenSet = false; Aws::Utils::DateTime m_lastUpdatedDate; bool m_lastUpdatedDateHasBeenSet = false; Aws::Vector m_stageKeys; bool m_stageKeysHasBeenSet = false; Aws::Map m_tags; bool m_tagsHasBeenSet = false; Aws::String m_requestId; bool m_requestIdHasBeenSet = false; }; } // namespace Model } // namespace APIGateway } // namespace Aws