/** * 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 namespace Aws { namespace WorkSpacesWeb { namespace Model { /** */ class CreatePortalRequest : public WorkSpacesWebRequest { public: AWS_WORKSPACESWEB_API CreatePortalRequest(); // Service request name is the Operation name which will send this request out, // each operation should has unique request name, so that we can get operation's name from this request. // Note: this is not true for response, multiple operations may have the same response name, // so we can not get operation's name from response. inline virtual const char* GetServiceRequestName() const override { return "CreatePortal"; } AWS_WORKSPACESWEB_API Aws::String SerializePayload() const override; /** *

The additional encryption context of the portal.

*/ inline const Aws::Map& GetAdditionalEncryptionContext() const{ return m_additionalEncryptionContext; } /** *

The additional encryption context of the portal.

*/ inline bool AdditionalEncryptionContextHasBeenSet() const { return m_additionalEncryptionContextHasBeenSet; } /** *

The additional encryption context of the portal.

*/ inline void SetAdditionalEncryptionContext(const Aws::Map& value) { m_additionalEncryptionContextHasBeenSet = true; m_additionalEncryptionContext = value; } /** *

The additional encryption context of the portal.

*/ inline void SetAdditionalEncryptionContext(Aws::Map&& value) { m_additionalEncryptionContextHasBeenSet = true; m_additionalEncryptionContext = std::move(value); } /** *

The additional encryption context of the portal.

*/ inline CreatePortalRequest& WithAdditionalEncryptionContext(const Aws::Map& value) { SetAdditionalEncryptionContext(value); return *this;} /** *

The additional encryption context of the portal.

*/ inline CreatePortalRequest& WithAdditionalEncryptionContext(Aws::Map&& value) { SetAdditionalEncryptionContext(std::move(value)); return *this;} /** *

The additional encryption context of the portal.

*/ inline CreatePortalRequest& AddAdditionalEncryptionContext(const Aws::String& key, const Aws::String& value) { m_additionalEncryptionContextHasBeenSet = true; m_additionalEncryptionContext.emplace(key, value); return *this; } /** *

The additional encryption context of the portal.

*/ inline CreatePortalRequest& AddAdditionalEncryptionContext(Aws::String&& key, const Aws::String& value) { m_additionalEncryptionContextHasBeenSet = true; m_additionalEncryptionContext.emplace(std::move(key), value); return *this; } /** *

The additional encryption context of the portal.

*/ inline CreatePortalRequest& AddAdditionalEncryptionContext(const Aws::String& key, Aws::String&& value) { m_additionalEncryptionContextHasBeenSet = true; m_additionalEncryptionContext.emplace(key, std::move(value)); return *this; } /** *

The additional encryption context of the portal.

*/ inline CreatePortalRequest& AddAdditionalEncryptionContext(Aws::String&& key, Aws::String&& value) { m_additionalEncryptionContextHasBeenSet = true; m_additionalEncryptionContext.emplace(std::move(key), std::move(value)); return *this; } /** *

The additional encryption context of the portal.

*/ inline CreatePortalRequest& AddAdditionalEncryptionContext(const char* key, Aws::String&& value) { m_additionalEncryptionContextHasBeenSet = true; m_additionalEncryptionContext.emplace(key, std::move(value)); return *this; } /** *

The additional encryption context of the portal.

*/ inline CreatePortalRequest& AddAdditionalEncryptionContext(Aws::String&& key, const char* value) { m_additionalEncryptionContextHasBeenSet = true; m_additionalEncryptionContext.emplace(std::move(key), value); return *this; } /** *

The additional encryption context of the portal.

*/ inline CreatePortalRequest& AddAdditionalEncryptionContext(const char* key, const char* value) { m_additionalEncryptionContextHasBeenSet = true; m_additionalEncryptionContext.emplace(key, value); return *this; } /** *

The type of authentication integration points used when signing into the web * portal. Defaults to Standard.

Standard web * portals are authenticated directly through your identity provider. You need to * call CreateIdentityProvider to integrate your identity provider * with your web portal. User and group access to your web portal is controlled * through your identity provider.

IAM_Identity_Center web * portals are authenticated through AWS IAM Identity Center (successor to AWS * Single Sign-On). They provide additional features, such as IdP-initiated * authentication. Identity sources (including external identity provider * integration), plus user and group access to your web portal, can be configured * in the IAM Identity Center.

*/ inline const AuthenticationType& GetAuthenticationType() const{ return m_authenticationType; } /** *

The type of authentication integration points used when signing into the web * portal. Defaults to Standard.

Standard web * portals are authenticated directly through your identity provider. You need to * call CreateIdentityProvider to integrate your identity provider * with your web portal. User and group access to your web portal is controlled * through your identity provider.

IAM_Identity_Center web * portals are authenticated through AWS IAM Identity Center (successor to AWS * Single Sign-On). They provide additional features, such as IdP-initiated * authentication. Identity sources (including external identity provider * integration), plus user and group access to your web portal, can be configured * in the IAM Identity Center.

*/ inline bool AuthenticationTypeHasBeenSet() const { return m_authenticationTypeHasBeenSet; } /** *

The type of authentication integration points used when signing into the web * portal. Defaults to Standard.

Standard web * portals are authenticated directly through your identity provider. You need to * call CreateIdentityProvider to integrate your identity provider * with your web portal. User and group access to your web portal is controlled * through your identity provider.

IAM_Identity_Center web * portals are authenticated through AWS IAM Identity Center (successor to AWS * Single Sign-On). They provide additional features, such as IdP-initiated * authentication. Identity sources (including external identity provider * integration), plus user and group access to your web portal, can be configured * in the IAM Identity Center.

*/ inline void SetAuthenticationType(const AuthenticationType& value) { m_authenticationTypeHasBeenSet = true; m_authenticationType = value; } /** *

The type of authentication integration points used when signing into the web * portal. Defaults to Standard.

Standard web * portals are authenticated directly through your identity provider. You need to * call CreateIdentityProvider to integrate your identity provider * with your web portal. User and group access to your web portal is controlled * through your identity provider.

IAM_Identity_Center web * portals are authenticated through AWS IAM Identity Center (successor to AWS * Single Sign-On). They provide additional features, such as IdP-initiated * authentication. Identity sources (including external identity provider * integration), plus user and group access to your web portal, can be configured * in the IAM Identity Center.

*/ inline void SetAuthenticationType(AuthenticationType&& value) { m_authenticationTypeHasBeenSet = true; m_authenticationType = std::move(value); } /** *

The type of authentication integration points used when signing into the web * portal. Defaults to Standard.

Standard web * portals are authenticated directly through your identity provider. You need to * call CreateIdentityProvider to integrate your identity provider * with your web portal. User and group access to your web portal is controlled * through your identity provider.

IAM_Identity_Center web * portals are authenticated through AWS IAM Identity Center (successor to AWS * Single Sign-On). They provide additional features, such as IdP-initiated * authentication. Identity sources (including external identity provider * integration), plus user and group access to your web portal, can be configured * in the IAM Identity Center.

*/ inline CreatePortalRequest& WithAuthenticationType(const AuthenticationType& value) { SetAuthenticationType(value); return *this;} /** *

The type of authentication integration points used when signing into the web * portal. Defaults to Standard.

Standard web * portals are authenticated directly through your identity provider. You need to * call CreateIdentityProvider to integrate your identity provider * with your web portal. User and group access to your web portal is controlled * through your identity provider.

IAM_Identity_Center web * portals are authenticated through AWS IAM Identity Center (successor to AWS * Single Sign-On). They provide additional features, such as IdP-initiated * authentication. Identity sources (including external identity provider * integration), plus user and group access to your web portal, can be configured * in the IAM Identity Center.

*/ inline CreatePortalRequest& WithAuthenticationType(AuthenticationType&& value) { SetAuthenticationType(std::move(value)); return *this;} /** *

A unique, case-sensitive identifier that you provide to ensure the * idempotency of the request. Idempotency ensures that an API request completes * only once. With an idempotent request, if the original request completes * successfully, subsequent retries with the same client token returns the result * from the original successful request.

If you do not specify a client * token, one is automatically generated by the AWS SDK.

*/ inline const Aws::String& GetClientToken() const{ return m_clientToken; } /** *

A unique, case-sensitive identifier that you provide to ensure the * idempotency of the request. Idempotency ensures that an API request completes * only once. With an idempotent request, if the original request completes * successfully, subsequent retries with the same client token returns the result * from the original successful request.

If you do not specify a client * token, one is automatically generated by the AWS SDK.

*/ inline bool ClientTokenHasBeenSet() const { return m_clientTokenHasBeenSet; } /** *

A unique, case-sensitive identifier that you provide to ensure the * idempotency of the request. Idempotency ensures that an API request completes * only once. With an idempotent request, if the original request completes * successfully, subsequent retries with the same client token returns the result * from the original successful request.

If you do not specify a client * token, one is automatically generated by the AWS SDK.

*/ inline void SetClientToken(const Aws::String& value) { m_clientTokenHasBeenSet = true; m_clientToken = value; } /** *

A unique, case-sensitive identifier that you provide to ensure the * idempotency of the request. Idempotency ensures that an API request completes * only once. With an idempotent request, if the original request completes * successfully, subsequent retries with the same client token returns the result * from the original successful request.

If you do not specify a client * token, one is automatically generated by the AWS SDK.

*/ inline void SetClientToken(Aws::String&& value) { m_clientTokenHasBeenSet = true; m_clientToken = std::move(value); } /** *

A unique, case-sensitive identifier that you provide to ensure the * idempotency of the request. Idempotency ensures that an API request completes * only once. With an idempotent request, if the original request completes * successfully, subsequent retries with the same client token returns the result * from the original successful request.

If you do not specify a client * token, one is automatically generated by the AWS SDK.

*/ inline void SetClientToken(const char* value) { m_clientTokenHasBeenSet = true; m_clientToken.assign(value); } /** *

A unique, case-sensitive identifier that you provide to ensure the * idempotency of the request. Idempotency ensures that an API request completes * only once. With an idempotent request, if the original request completes * successfully, subsequent retries with the same client token returns the result * from the original successful request.

If you do not specify a client * token, one is automatically generated by the AWS SDK.

*/ inline CreatePortalRequest& WithClientToken(const Aws::String& value) { SetClientToken(value); return *this;} /** *

A unique, case-sensitive identifier that you provide to ensure the * idempotency of the request. Idempotency ensures that an API request completes * only once. With an idempotent request, if the original request completes * successfully, subsequent retries with the same client token returns the result * from the original successful request.

If you do not specify a client * token, one is automatically generated by the AWS SDK.

*/ inline CreatePortalRequest& WithClientToken(Aws::String&& value) { SetClientToken(std::move(value)); return *this;} /** *

A unique, case-sensitive identifier that you provide to ensure the * idempotency of the request. Idempotency ensures that an API request completes * only once. With an idempotent request, if the original request completes * successfully, subsequent retries with the same client token returns the result * from the original successful request.

If you do not specify a client * token, one is automatically generated by the AWS SDK.

*/ inline CreatePortalRequest& WithClientToken(const char* value) { SetClientToken(value); return *this;} /** *

The customer managed key of the web portal.

*/ inline const Aws::String& GetCustomerManagedKey() const{ return m_customerManagedKey; } /** *

The customer managed key of the web portal.

*/ inline bool CustomerManagedKeyHasBeenSet() const { return m_customerManagedKeyHasBeenSet; } /** *

The customer managed key of the web portal.

*/ inline void SetCustomerManagedKey(const Aws::String& value) { m_customerManagedKeyHasBeenSet = true; m_customerManagedKey = value; } /** *

The customer managed key of the web portal.

*/ inline void SetCustomerManagedKey(Aws::String&& value) { m_customerManagedKeyHasBeenSet = true; m_customerManagedKey = std::move(value); } /** *

The customer managed key of the web portal.

*/ inline void SetCustomerManagedKey(const char* value) { m_customerManagedKeyHasBeenSet = true; m_customerManagedKey.assign(value); } /** *

The customer managed key of the web portal.

*/ inline CreatePortalRequest& WithCustomerManagedKey(const Aws::String& value) { SetCustomerManagedKey(value); return *this;} /** *

The customer managed key of the web portal.

*/ inline CreatePortalRequest& WithCustomerManagedKey(Aws::String&& value) { SetCustomerManagedKey(std::move(value)); return *this;} /** *

The customer managed key of the web portal.

*/ inline CreatePortalRequest& WithCustomerManagedKey(const char* value) { SetCustomerManagedKey(value); return *this;} /** *

The name of the web portal. This is not visible to users who log into the web * portal.

*/ inline const Aws::String& GetDisplayName() const{ return m_displayName; } /** *

The name of the web portal. This is not visible to users who log into the web * portal.

*/ inline bool DisplayNameHasBeenSet() const { return m_displayNameHasBeenSet; } /** *

The name of the web portal. This is not visible to users who log into the web * portal.

*/ inline void SetDisplayName(const Aws::String& value) { m_displayNameHasBeenSet = true; m_displayName = value; } /** *

The name of the web portal. This is not visible to users who log into the web * portal.

*/ inline void SetDisplayName(Aws::String&& value) { m_displayNameHasBeenSet = true; m_displayName = std::move(value); } /** *

The name of the web portal. This is not visible to users who log into the web * portal.

*/ inline void SetDisplayName(const char* value) { m_displayNameHasBeenSet = true; m_displayName.assign(value); } /** *

The name of the web portal. This is not visible to users who log into the web * portal.

*/ inline CreatePortalRequest& WithDisplayName(const Aws::String& value) { SetDisplayName(value); return *this;} /** *

The name of the web portal. This is not visible to users who log into the web * portal.

*/ inline CreatePortalRequest& WithDisplayName(Aws::String&& value) { SetDisplayName(std::move(value)); return *this;} /** *

The name of the web portal. This is not visible to users who log into the web * portal.

*/ inline CreatePortalRequest& WithDisplayName(const char* value) { SetDisplayName(value); return *this;} /** *

The tags to add to the web portal. A tag is a key-value pair.

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

The tags to add to the web portal. A tag is a key-value pair.

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

The tags to add to the web portal. A tag is a key-value pair.

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

The tags to add to the web portal. A tag is a key-value pair.

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

The tags to add to the web portal. A tag is a key-value pair.

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

The tags to add to the web portal. A tag is a key-value pair.

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

The tags to add to the web portal. A tag is a key-value pair.

*/ inline CreatePortalRequest& AddTags(const Tag& value) { m_tagsHasBeenSet = true; m_tags.push_back(value); return *this; } /** *

The tags to add to the web portal. A tag is a key-value pair.

*/ inline CreatePortalRequest& AddTags(Tag&& value) { m_tagsHasBeenSet = true; m_tags.push_back(std::move(value)); return *this; } private: Aws::Map m_additionalEncryptionContext; bool m_additionalEncryptionContextHasBeenSet = false; AuthenticationType m_authenticationType; bool m_authenticationTypeHasBeenSet = false; Aws::String m_clientToken; bool m_clientTokenHasBeenSet = false; Aws::String m_customerManagedKey; bool m_customerManagedKeyHasBeenSet = false; Aws::String m_displayName; bool m_displayNameHasBeenSet = false; Aws::Vector m_tags; bool m_tagsHasBeenSet = false; }; } // namespace Model } // namespace WorkSpacesWeb } // namespace Aws