AWS SDK for C++  1.9.40
AWS SDK for C++
Public Member Functions | List of all members
Aws::APIGateway::Model::UpdateDomainNameResult Class Reference

#include <UpdateDomainNameResult.h>

Public Member Functions

 UpdateDomainNameResult ()
 
 UpdateDomainNameResult (const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
 
UpdateDomainNameResultoperator= (const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
 
const Aws::StringGetDomainName () const
 
void SetDomainName (const Aws::String &value)
 
void SetDomainName (Aws::String &&value)
 
void SetDomainName (const char *value)
 
UpdateDomainNameResultWithDomainName (const Aws::String &value)
 
UpdateDomainNameResultWithDomainName (Aws::String &&value)
 
UpdateDomainNameResultWithDomainName (const char *value)
 
const Aws::StringGetCertificateName () const
 
void SetCertificateName (const Aws::String &value)
 
void SetCertificateName (Aws::String &&value)
 
void SetCertificateName (const char *value)
 
UpdateDomainNameResultWithCertificateName (const Aws::String &value)
 
UpdateDomainNameResultWithCertificateName (Aws::String &&value)
 
UpdateDomainNameResultWithCertificateName (const char *value)
 
const Aws::StringGetCertificateArn () const
 
void SetCertificateArn (const Aws::String &value)
 
void SetCertificateArn (Aws::String &&value)
 
void SetCertificateArn (const char *value)
 
UpdateDomainNameResultWithCertificateArn (const Aws::String &value)
 
UpdateDomainNameResultWithCertificateArn (Aws::String &&value)
 
UpdateDomainNameResultWithCertificateArn (const char *value)
 
const Aws::Utils::DateTimeGetCertificateUploadDate () const
 
void SetCertificateUploadDate (const Aws::Utils::DateTime &value)
 
void SetCertificateUploadDate (Aws::Utils::DateTime &&value)
 
UpdateDomainNameResultWithCertificateUploadDate (const Aws::Utils::DateTime &value)
 
UpdateDomainNameResultWithCertificateUploadDate (Aws::Utils::DateTime &&value)
 
const Aws::StringGetRegionalDomainName () const
 
void SetRegionalDomainName (const Aws::String &value)
 
void SetRegionalDomainName (Aws::String &&value)
 
void SetRegionalDomainName (const char *value)
 
UpdateDomainNameResultWithRegionalDomainName (const Aws::String &value)
 
UpdateDomainNameResultWithRegionalDomainName (Aws::String &&value)
 
UpdateDomainNameResultWithRegionalDomainName (const char *value)
 
const Aws::StringGetRegionalHostedZoneId () const
 
void SetRegionalHostedZoneId (const Aws::String &value)
 
void SetRegionalHostedZoneId (Aws::String &&value)
 
void SetRegionalHostedZoneId (const char *value)
 
UpdateDomainNameResultWithRegionalHostedZoneId (const Aws::String &value)
 
UpdateDomainNameResultWithRegionalHostedZoneId (Aws::String &&value)
 
UpdateDomainNameResultWithRegionalHostedZoneId (const char *value)
 
const Aws::StringGetRegionalCertificateName () const
 
void SetRegionalCertificateName (const Aws::String &value)
 
void SetRegionalCertificateName (Aws::String &&value)
 
void SetRegionalCertificateName (const char *value)
 
UpdateDomainNameResultWithRegionalCertificateName (const Aws::String &value)
 
UpdateDomainNameResultWithRegionalCertificateName (Aws::String &&value)
 
UpdateDomainNameResultWithRegionalCertificateName (const char *value)
 
const Aws::StringGetRegionalCertificateArn () const
 
void SetRegionalCertificateArn (const Aws::String &value)
 
void SetRegionalCertificateArn (Aws::String &&value)
 
void SetRegionalCertificateArn (const char *value)
 
UpdateDomainNameResultWithRegionalCertificateArn (const Aws::String &value)
 
UpdateDomainNameResultWithRegionalCertificateArn (Aws::String &&value)
 
UpdateDomainNameResultWithRegionalCertificateArn (const char *value)
 
const Aws::StringGetDistributionDomainName () const
 
void SetDistributionDomainName (const Aws::String &value)
 
void SetDistributionDomainName (Aws::String &&value)
 
void SetDistributionDomainName (const char *value)
 
UpdateDomainNameResultWithDistributionDomainName (const Aws::String &value)
 
UpdateDomainNameResultWithDistributionDomainName (Aws::String &&value)
 
UpdateDomainNameResultWithDistributionDomainName (const char *value)
 
const Aws::StringGetDistributionHostedZoneId () const
 
void SetDistributionHostedZoneId (const Aws::String &value)
 
void SetDistributionHostedZoneId (Aws::String &&value)
 
void SetDistributionHostedZoneId (const char *value)
 
UpdateDomainNameResultWithDistributionHostedZoneId (const Aws::String &value)
 
UpdateDomainNameResultWithDistributionHostedZoneId (Aws::String &&value)
 
UpdateDomainNameResultWithDistributionHostedZoneId (const char *value)
 
const EndpointConfigurationGetEndpointConfiguration () const
 
void SetEndpointConfiguration (const EndpointConfiguration &value)
 
void SetEndpointConfiguration (EndpointConfiguration &&value)
 
UpdateDomainNameResultWithEndpointConfiguration (const EndpointConfiguration &value)
 
UpdateDomainNameResultWithEndpointConfiguration (EndpointConfiguration &&value)
 
const DomainNameStatusGetDomainNameStatus () const
 
void SetDomainNameStatus (const DomainNameStatus &value)
 
void SetDomainNameStatus (DomainNameStatus &&value)
 
UpdateDomainNameResultWithDomainNameStatus (const DomainNameStatus &value)
 
UpdateDomainNameResultWithDomainNameStatus (DomainNameStatus &&value)
 
const Aws::StringGetDomainNameStatusMessage () const
 
void SetDomainNameStatusMessage (const Aws::String &value)
 
void SetDomainNameStatusMessage (Aws::String &&value)
 
void SetDomainNameStatusMessage (const char *value)
 
UpdateDomainNameResultWithDomainNameStatusMessage (const Aws::String &value)
 
UpdateDomainNameResultWithDomainNameStatusMessage (Aws::String &&value)
 
UpdateDomainNameResultWithDomainNameStatusMessage (const char *value)
 
const SecurityPolicyGetSecurityPolicy () const
 
void SetSecurityPolicy (const SecurityPolicy &value)
 
void SetSecurityPolicy (SecurityPolicy &&value)
 
UpdateDomainNameResultWithSecurityPolicy (const SecurityPolicy &value)
 
UpdateDomainNameResultWithSecurityPolicy (SecurityPolicy &&value)
 
const Aws::Map< Aws::String, Aws::String > & GetTags () const
 
void SetTags (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetTags (Aws::Map< Aws::String, Aws::String > &&value)
 
UpdateDomainNameResultWithTags (const Aws::Map< Aws::String, Aws::String > &value)
 
UpdateDomainNameResultWithTags (Aws::Map< Aws::String, Aws::String > &&value)
 
UpdateDomainNameResultAddTags (const Aws::String &key, const Aws::String &value)
 
UpdateDomainNameResultAddTags (Aws::String &&key, const Aws::String &value)
 
UpdateDomainNameResultAddTags (const Aws::String &key, Aws::String &&value)
 
UpdateDomainNameResultAddTags (Aws::String &&key, Aws::String &&value)
 
UpdateDomainNameResultAddTags (const char *key, Aws::String &&value)
 
UpdateDomainNameResultAddTags (Aws::String &&key, const char *value)
 
UpdateDomainNameResultAddTags (const char *key, const char *value)
 
const MutualTlsAuthenticationGetMutualTlsAuthentication () const
 
void SetMutualTlsAuthentication (const MutualTlsAuthentication &value)
 
void SetMutualTlsAuthentication (MutualTlsAuthentication &&value)
 
UpdateDomainNameResultWithMutualTlsAuthentication (const MutualTlsAuthentication &value)
 
UpdateDomainNameResultWithMutualTlsAuthentication (MutualTlsAuthentication &&value)
 

Detailed Description

Represents a custom domain name as a user-friendly host name of an API (RestApi).

When you deploy an API, API Gateway creates a default host name for the API. This default API host name is of the {restapi-id}.execute-api.{region}.amazonaws.com format. With the default host name, you can access the API's root resource with the URL of https://{restapi-id}.execute-api.{region}.amazonaws.com/{stage}/. When you set up a custom domain name of apis.example.com for this API, you can then access the same resource using the URL of the https://apis.examples.com/myApi, where myApi is the base path mapping (BasePathMapping) of your API under the custom domain name.

See Also:

AWS API Reference

Definition at line 50 of file UpdateDomainNameResult.h.

Constructor & Destructor Documentation

◆ UpdateDomainNameResult() [1/2]

Aws::APIGateway::Model::UpdateDomainNameResult::UpdateDomainNameResult ( )

◆ UpdateDomainNameResult() [2/2]

Aws::APIGateway::Model::UpdateDomainNameResult::UpdateDomainNameResult ( const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &  result)

Member Function Documentation

◆ AddTags() [1/7]

UpdateDomainNameResult& Aws::APIGateway::Model::UpdateDomainNameResult::AddTags ( Aws::String &&  key,
Aws::String &&  value 
)
inline

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

Definition at line 803 of file UpdateDomainNameResult.h.

◆ AddTags() [2/7]

UpdateDomainNameResult& Aws::APIGateway::Model::UpdateDomainNameResult::AddTags ( Aws::String &&  key,
const Aws::String value 
)
inline

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

Definition at line 791 of file UpdateDomainNameResult.h.

◆ AddTags() [3/7]

UpdateDomainNameResult& Aws::APIGateway::Model::UpdateDomainNameResult::AddTags ( Aws::String &&  key,
const char *  value 
)
inline

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

Definition at line 815 of file UpdateDomainNameResult.h.

◆ AddTags() [4/7]

UpdateDomainNameResult& Aws::APIGateway::Model::UpdateDomainNameResult::AddTags ( const Aws::String key,
Aws::String &&  value 
)
inline

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

Definition at line 797 of file UpdateDomainNameResult.h.

◆ AddTags() [5/7]

UpdateDomainNameResult& Aws::APIGateway::Model::UpdateDomainNameResult::AddTags ( const Aws::String key,
const Aws::String value 
)
inline

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

Definition at line 785 of file UpdateDomainNameResult.h.

◆ AddTags() [6/7]

UpdateDomainNameResult& Aws::APIGateway::Model::UpdateDomainNameResult::AddTags ( const char *  key,
Aws::String &&  value 
)
inline

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

Definition at line 809 of file UpdateDomainNameResult.h.

◆ AddTags() [7/7]

UpdateDomainNameResult& Aws::APIGateway::Model::UpdateDomainNameResult::AddTags ( const char *  key,
const char *  value 
)
inline

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

Definition at line 821 of file UpdateDomainNameResult.h.

◆ GetCertificateArn()

const Aws::String& Aws::APIGateway::Model::UpdateDomainNameResult::GetCertificateArn ( ) const
inline

The reference to an AWS-managed certificate that will be used by edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.

Definition at line 149 of file UpdateDomainNameResult.h.

◆ GetCertificateName()

const Aws::String& Aws::APIGateway::Model::UpdateDomainNameResult::GetCertificateName ( ) const
inline

The name of the certificate that will be used by edge-optimized endpoint for this domain name.

Definition at line 105 of file UpdateDomainNameResult.h.

◆ GetCertificateUploadDate()

const Aws::Utils::DateTime& Aws::APIGateway::Model::UpdateDomainNameResult::GetCertificateUploadDate ( ) const
inline

The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.

Definition at line 198 of file UpdateDomainNameResult.h.

◆ GetDistributionDomainName()

const Aws::String& Aws::APIGateway::Model::UpdateDomainNameResult::GetDistributionDomainName ( ) const
inline

The domain name of the Amazon CloudFront distribution associated with this custom domain name for an edge-optimized endpoint. You set up this association when adding a DNS record pointing the custom domain name to this distribution name. For more information about CloudFront distributions, see the Amazon CloudFront documentation.

Definition at line 454 of file UpdateDomainNameResult.h.

◆ GetDistributionHostedZoneId()

const Aws::String& Aws::APIGateway::Model::UpdateDomainNameResult::GetDistributionHostedZoneId ( ) const
inline

The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint. The valid value is Z2FDTNDATAQYW2 for all the regions. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.

Definition at line 526 of file UpdateDomainNameResult.h.

◆ GetDomainName()

const Aws::String& Aws::APIGateway::Model::UpdateDomainNameResult::GetDomainName ( ) const
inline

The custom domain name as an API host name, for example, my-api.example.com.

Definition at line 62 of file UpdateDomainNameResult.h.

◆ GetDomainNameStatus()

const DomainNameStatus& Aws::APIGateway::Model::UpdateDomainNameResult::GetDomainNameStatus ( ) const
inline

The status of the DomainName migration. The valid values are AVAILABLE and UPDATING. If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated.

Definition at line 633 of file UpdateDomainNameResult.h.

◆ GetDomainNameStatusMessage()

const Aws::String& Aws::APIGateway::Model::UpdateDomainNameResult::GetDomainNameStatusMessage ( ) const
inline

An optional text message containing detailed information about status of the DomainName migration.

Definition at line 676 of file UpdateDomainNameResult.h.

◆ GetEndpointConfiguration()

const EndpointConfiguration& Aws::APIGateway::Model::UpdateDomainNameResult::GetEndpointConfiguration ( ) const
inline

The endpoint configuration of this DomainName showing the endpoint types of the domain name.

Definition at line 599 of file UpdateDomainNameResult.h.

◆ GetMutualTlsAuthentication()

const MutualTlsAuthentication& Aws::APIGateway::Model::UpdateDomainNameResult::GetMutualTlsAuthentication ( ) const
inline

The mutual TLS authentication configuration for a custom domain name. If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.

Definition at line 829 of file UpdateDomainNameResult.h.

◆ GetRegionalCertificateArn()

const Aws::String& Aws::APIGateway::Model::UpdateDomainNameResult::GetRegionalCertificateArn ( ) const
inline

The reference to an AWS-managed certificate that will be used for validating the regional domain name. AWS Certificate Manager is the only supported source.

Definition at line 401 of file UpdateDomainNameResult.h.

◆ GetRegionalCertificateName()

const Aws::String& Aws::APIGateway::Model::UpdateDomainNameResult::GetRegionalCertificateName ( ) const
inline

The name of the certificate that will be used for validating the regional domain name.

Definition at line 357 of file UpdateDomainNameResult.h.

◆ GetRegionalDomainName()

const Aws::String& Aws::APIGateway::Model::UpdateDomainNameResult::GetRegionalDomainName ( ) const
inline

The domain name associated with the regional endpoint for this custom domain name. You set up this association by adding a DNS record that points the custom domain name to this regional domain name. The regional domain name is returned by API Gateway when you create a regional endpoint.

Definition at line 231 of file UpdateDomainNameResult.h.

◆ GetRegionalHostedZoneId()

const Aws::String& Aws::APIGateway::Model::UpdateDomainNameResult::GetRegionalHostedZoneId ( ) const
inline

The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.

Definition at line 290 of file UpdateDomainNameResult.h.

◆ GetSecurityPolicy()

const SecurityPolicy& Aws::APIGateway::Model::UpdateDomainNameResult::GetSecurityPolicy ( ) const
inline

The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are TLS_1_0 and TLS_1_2.

Definition at line 720 of file UpdateDomainNameResult.h.

◆ GetTags()

const Aws::Map<Aws::String, Aws::String>& Aws::APIGateway::Model::UpdateDomainNameResult::GetTags ( ) const
inline

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

Definition at line 755 of file UpdateDomainNameResult.h.

◆ operator=()

UpdateDomainNameResult& Aws::APIGateway::Model::UpdateDomainNameResult::operator= ( const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &  result)

◆ SetCertificateArn() [1/3]

void Aws::APIGateway::Model::UpdateDomainNameResult::SetCertificateArn ( Aws::String &&  value)
inline

The reference to an AWS-managed certificate that will be used by edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.

Definition at line 163 of file UpdateDomainNameResult.h.

◆ SetCertificateArn() [2/3]

void Aws::APIGateway::Model::UpdateDomainNameResult::SetCertificateArn ( const Aws::String value)
inline

The reference to an AWS-managed certificate that will be used by edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.

Definition at line 156 of file UpdateDomainNameResult.h.

◆ SetCertificateArn() [3/3]

void Aws::APIGateway::Model::UpdateDomainNameResult::SetCertificateArn ( const char *  value)
inline

The reference to an AWS-managed certificate that will be used by edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.

Definition at line 170 of file UpdateDomainNameResult.h.

◆ SetCertificateName() [1/3]

void Aws::APIGateway::Model::UpdateDomainNameResult::SetCertificateName ( Aws::String &&  value)
inline

The name of the certificate that will be used by edge-optimized endpoint for this domain name.

Definition at line 117 of file UpdateDomainNameResult.h.

◆ SetCertificateName() [2/3]

void Aws::APIGateway::Model::UpdateDomainNameResult::SetCertificateName ( const Aws::String value)
inline

The name of the certificate that will be used by edge-optimized endpoint for this domain name.

Definition at line 111 of file UpdateDomainNameResult.h.

◆ SetCertificateName() [3/3]

void Aws::APIGateway::Model::UpdateDomainNameResult::SetCertificateName ( const char *  value)
inline

The name of the certificate that will be used by edge-optimized endpoint for this domain name.

Definition at line 123 of file UpdateDomainNameResult.h.

◆ SetCertificateUploadDate() [1/2]

void Aws::APIGateway::Model::UpdateDomainNameResult::SetCertificateUploadDate ( Aws::Utils::DateTime &&  value)
inline

The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.

Definition at line 210 of file UpdateDomainNameResult.h.

◆ SetCertificateUploadDate() [2/2]

void Aws::APIGateway::Model::UpdateDomainNameResult::SetCertificateUploadDate ( const Aws::Utils::DateTime value)
inline

The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.

Definition at line 204 of file UpdateDomainNameResult.h.

◆ SetDistributionDomainName() [1/3]

void Aws::APIGateway::Model::UpdateDomainNameResult::SetDistributionDomainName ( Aws::String &&  value)
inline

The domain name of the Amazon CloudFront distribution associated with this custom domain name for an edge-optimized endpoint. You set up this association when adding a DNS record pointing the custom domain name to this distribution name. For more information about CloudFront distributions, see the Amazon CloudFront documentation.

Definition at line 474 of file UpdateDomainNameResult.h.

◆ SetDistributionDomainName() [2/3]

void Aws::APIGateway::Model::UpdateDomainNameResult::SetDistributionDomainName ( const Aws::String value)
inline

The domain name of the Amazon CloudFront distribution associated with this custom domain name for an edge-optimized endpoint. You set up this association when adding a DNS record pointing the custom domain name to this distribution name. For more information about CloudFront distributions, see the Amazon CloudFront documentation.

Definition at line 464 of file UpdateDomainNameResult.h.

◆ SetDistributionDomainName() [3/3]

void Aws::APIGateway::Model::UpdateDomainNameResult::SetDistributionDomainName ( const char *  value)
inline

The domain name of the Amazon CloudFront distribution associated with this custom domain name for an edge-optimized endpoint. You set up this association when adding a DNS record pointing the custom domain name to this distribution name. For more information about CloudFront distributions, see the Amazon CloudFront documentation.

Definition at line 484 of file UpdateDomainNameResult.h.

◆ SetDistributionHostedZoneId() [1/3]

void Aws::APIGateway::Model::UpdateDomainNameResult::SetDistributionHostedZoneId ( Aws::String &&  value)
inline

The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint. The valid value is Z2FDTNDATAQYW2 for all the regions. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.

Definition at line 548 of file UpdateDomainNameResult.h.

◆ SetDistributionHostedZoneId() [2/3]

void Aws::APIGateway::Model::UpdateDomainNameResult::SetDistributionHostedZoneId ( const Aws::String value)
inline

The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint. The valid value is Z2FDTNDATAQYW2 for all the regions. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.

Definition at line 537 of file UpdateDomainNameResult.h.

◆ SetDistributionHostedZoneId() [3/3]

void Aws::APIGateway::Model::UpdateDomainNameResult::SetDistributionHostedZoneId ( const char *  value)
inline

The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint. The valid value is Z2FDTNDATAQYW2 for all the regions. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.

Definition at line 559 of file UpdateDomainNameResult.h.

◆ SetDomainName() [1/3]

void Aws::APIGateway::Model::UpdateDomainNameResult::SetDomainName ( Aws::String &&  value)
inline

The custom domain name as an API host name, for example, my-api.example.com.

Definition at line 74 of file UpdateDomainNameResult.h.

◆ SetDomainName() [2/3]

void Aws::APIGateway::Model::UpdateDomainNameResult::SetDomainName ( const Aws::String value)
inline

The custom domain name as an API host name, for example, my-api.example.com.

Definition at line 68 of file UpdateDomainNameResult.h.

◆ SetDomainName() [3/3]

void Aws::APIGateway::Model::UpdateDomainNameResult::SetDomainName ( const char *  value)
inline

The custom domain name as an API host name, for example, my-api.example.com.

Definition at line 80 of file UpdateDomainNameResult.h.

◆ SetDomainNameStatus() [1/2]

void Aws::APIGateway::Model::UpdateDomainNameResult::SetDomainNameStatus ( const DomainNameStatus value)
inline

The status of the DomainName migration. The valid values are AVAILABLE and UPDATING. If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated.

Definition at line 642 of file UpdateDomainNameResult.h.

◆ SetDomainNameStatus() [2/2]

void Aws::APIGateway::Model::UpdateDomainNameResult::SetDomainNameStatus ( DomainNameStatus &&  value)
inline

The status of the DomainName migration. The valid values are AVAILABLE and UPDATING. If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated.

Definition at line 651 of file UpdateDomainNameResult.h.

◆ SetDomainNameStatusMessage() [1/3]

void Aws::APIGateway::Model::UpdateDomainNameResult::SetDomainNameStatusMessage ( Aws::String &&  value)
inline

An optional text message containing detailed information about status of the DomainName migration.

Definition at line 688 of file UpdateDomainNameResult.h.

◆ SetDomainNameStatusMessage() [2/3]

void Aws::APIGateway::Model::UpdateDomainNameResult::SetDomainNameStatusMessage ( const Aws::String value)
inline

An optional text message containing detailed information about status of the DomainName migration.

Definition at line 682 of file UpdateDomainNameResult.h.

◆ SetDomainNameStatusMessage() [3/3]

void Aws::APIGateway::Model::UpdateDomainNameResult::SetDomainNameStatusMessage ( const char *  value)
inline

An optional text message containing detailed information about status of the DomainName migration.

Definition at line 694 of file UpdateDomainNameResult.h.

◆ SetEndpointConfiguration() [1/2]

void Aws::APIGateway::Model::UpdateDomainNameResult::SetEndpointConfiguration ( const EndpointConfiguration value)
inline

The endpoint configuration of this DomainName showing the endpoint types of the domain name.

Definition at line 605 of file UpdateDomainNameResult.h.

◆ SetEndpointConfiguration() [2/2]

void Aws::APIGateway::Model::UpdateDomainNameResult::SetEndpointConfiguration ( EndpointConfiguration &&  value)
inline

The endpoint configuration of this DomainName showing the endpoint types of the domain name.

Definition at line 611 of file UpdateDomainNameResult.h.

◆ SetMutualTlsAuthentication() [1/2]

void Aws::APIGateway::Model::UpdateDomainNameResult::SetMutualTlsAuthentication ( const MutualTlsAuthentication value)
inline

The mutual TLS authentication configuration for a custom domain name. If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.

Definition at line 836 of file UpdateDomainNameResult.h.

◆ SetMutualTlsAuthentication() [2/2]

void Aws::APIGateway::Model::UpdateDomainNameResult::SetMutualTlsAuthentication ( MutualTlsAuthentication &&  value)
inline

The mutual TLS authentication configuration for a custom domain name. If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.

Definition at line 843 of file UpdateDomainNameResult.h.

◆ SetRegionalCertificateArn() [1/3]

void Aws::APIGateway::Model::UpdateDomainNameResult::SetRegionalCertificateArn ( Aws::String &&  value)
inline

The reference to an AWS-managed certificate that will be used for validating the regional domain name. AWS Certificate Manager is the only supported source.

Definition at line 415 of file UpdateDomainNameResult.h.

◆ SetRegionalCertificateArn() [2/3]

void Aws::APIGateway::Model::UpdateDomainNameResult::SetRegionalCertificateArn ( const Aws::String value)
inline

The reference to an AWS-managed certificate that will be used for validating the regional domain name. AWS Certificate Manager is the only supported source.

Definition at line 408 of file UpdateDomainNameResult.h.

◆ SetRegionalCertificateArn() [3/3]

void Aws::APIGateway::Model::UpdateDomainNameResult::SetRegionalCertificateArn ( const char *  value)
inline

The reference to an AWS-managed certificate that will be used for validating the regional domain name. AWS Certificate Manager is the only supported source.

Definition at line 422 of file UpdateDomainNameResult.h.

◆ SetRegionalCertificateName() [1/3]

void Aws::APIGateway::Model::UpdateDomainNameResult::SetRegionalCertificateName ( Aws::String &&  value)
inline

The name of the certificate that will be used for validating the regional domain name.

Definition at line 369 of file UpdateDomainNameResult.h.

◆ SetRegionalCertificateName() [2/3]

void Aws::APIGateway::Model::UpdateDomainNameResult::SetRegionalCertificateName ( const Aws::String value)
inline

The name of the certificate that will be used for validating the regional domain name.

Definition at line 363 of file UpdateDomainNameResult.h.

◆ SetRegionalCertificateName() [3/3]

void Aws::APIGateway::Model::UpdateDomainNameResult::SetRegionalCertificateName ( const char *  value)
inline

The name of the certificate that will be used for validating the regional domain name.

Definition at line 375 of file UpdateDomainNameResult.h.

◆ SetRegionalDomainName() [1/3]

void Aws::APIGateway::Model::UpdateDomainNameResult::SetRegionalDomainName ( Aws::String &&  value)
inline

The domain name associated with the regional endpoint for this custom domain name. You set up this association by adding a DNS record that points the custom domain name to this regional domain name. The regional domain name is returned by API Gateway when you create a regional endpoint.

Definition at line 247 of file UpdateDomainNameResult.h.

◆ SetRegionalDomainName() [2/3]

void Aws::APIGateway::Model::UpdateDomainNameResult::SetRegionalDomainName ( const Aws::String value)
inline

The domain name associated with the regional endpoint for this custom domain name. You set up this association by adding a DNS record that points the custom domain name to this regional domain name. The regional domain name is returned by API Gateway when you create a regional endpoint.

Definition at line 239 of file UpdateDomainNameResult.h.

◆ SetRegionalDomainName() [3/3]

void Aws::APIGateway::Model::UpdateDomainNameResult::SetRegionalDomainName ( const char *  value)
inline

The domain name associated with the regional endpoint for this custom domain name. You set up this association by adding a DNS record that points the custom domain name to this regional domain name. The regional domain name is returned by API Gateway when you create a regional endpoint.

Definition at line 255 of file UpdateDomainNameResult.h.

◆ SetRegionalHostedZoneId() [1/3]

void Aws::APIGateway::Model::UpdateDomainNameResult::SetRegionalHostedZoneId ( Aws::String &&  value)
inline

The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.

Definition at line 310 of file UpdateDomainNameResult.h.

◆ SetRegionalHostedZoneId() [2/3]

void Aws::APIGateway::Model::UpdateDomainNameResult::SetRegionalHostedZoneId ( const Aws::String value)
inline

The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.

Definition at line 300 of file UpdateDomainNameResult.h.

◆ SetRegionalHostedZoneId() [3/3]

void Aws::APIGateway::Model::UpdateDomainNameResult::SetRegionalHostedZoneId ( const char *  value)
inline

The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.

Definition at line 320 of file UpdateDomainNameResult.h.

◆ SetSecurityPolicy() [1/2]

void Aws::APIGateway::Model::UpdateDomainNameResult::SetSecurityPolicy ( const SecurityPolicy value)
inline

The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are TLS_1_0 and TLS_1_2.

Definition at line 727 of file UpdateDomainNameResult.h.

◆ SetSecurityPolicy() [2/2]

void Aws::APIGateway::Model::UpdateDomainNameResult::SetSecurityPolicy ( SecurityPolicy &&  value)
inline

The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are TLS_1_0 and TLS_1_2.

Definition at line 734 of file UpdateDomainNameResult.h.

◆ SetTags() [1/2]

void Aws::APIGateway::Model::UpdateDomainNameResult::SetTags ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

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

Definition at line 767 of file UpdateDomainNameResult.h.

◆ SetTags() [2/2]

void Aws::APIGateway::Model::UpdateDomainNameResult::SetTags ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

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

Definition at line 761 of file UpdateDomainNameResult.h.

◆ WithCertificateArn() [1/3]

UpdateDomainNameResult& Aws::APIGateway::Model::UpdateDomainNameResult::WithCertificateArn ( Aws::String &&  value)
inline

The reference to an AWS-managed certificate that will be used by edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.

Definition at line 184 of file UpdateDomainNameResult.h.

◆ WithCertificateArn() [2/3]

UpdateDomainNameResult& Aws::APIGateway::Model::UpdateDomainNameResult::WithCertificateArn ( const Aws::String value)
inline

The reference to an AWS-managed certificate that will be used by edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.

Definition at line 177 of file UpdateDomainNameResult.h.

◆ WithCertificateArn() [3/3]

UpdateDomainNameResult& Aws::APIGateway::Model::UpdateDomainNameResult::WithCertificateArn ( const char *  value)
inline

The reference to an AWS-managed certificate that will be used by edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.

Definition at line 191 of file UpdateDomainNameResult.h.

◆ WithCertificateName() [1/3]

UpdateDomainNameResult& Aws::APIGateway::Model::UpdateDomainNameResult::WithCertificateName ( Aws::String &&  value)
inline

The name of the certificate that will be used by edge-optimized endpoint for this domain name.

Definition at line 135 of file UpdateDomainNameResult.h.

◆ WithCertificateName() [2/3]

UpdateDomainNameResult& Aws::APIGateway::Model::UpdateDomainNameResult::WithCertificateName ( const Aws::String value)
inline

The name of the certificate that will be used by edge-optimized endpoint for this domain name.

Definition at line 129 of file UpdateDomainNameResult.h.

◆ WithCertificateName() [3/3]

UpdateDomainNameResult& Aws::APIGateway::Model::UpdateDomainNameResult::WithCertificateName ( const char *  value)
inline

The name of the certificate that will be used by edge-optimized endpoint for this domain name.

Definition at line 141 of file UpdateDomainNameResult.h.

◆ WithCertificateUploadDate() [1/2]

UpdateDomainNameResult& Aws::APIGateway::Model::UpdateDomainNameResult::WithCertificateUploadDate ( Aws::Utils::DateTime &&  value)
inline

The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.

Definition at line 222 of file UpdateDomainNameResult.h.

◆ WithCertificateUploadDate() [2/2]

UpdateDomainNameResult& Aws::APIGateway::Model::UpdateDomainNameResult::WithCertificateUploadDate ( const Aws::Utils::DateTime value)
inline

The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.

Definition at line 216 of file UpdateDomainNameResult.h.

◆ WithDistributionDomainName() [1/3]

UpdateDomainNameResult& Aws::APIGateway::Model::UpdateDomainNameResult::WithDistributionDomainName ( Aws::String &&  value)
inline

The domain name of the Amazon CloudFront distribution associated with this custom domain name for an edge-optimized endpoint. You set up this association when adding a DNS record pointing the custom domain name to this distribution name. For more information about CloudFront distributions, see the Amazon CloudFront documentation.

Definition at line 504 of file UpdateDomainNameResult.h.

◆ WithDistributionDomainName() [2/3]

UpdateDomainNameResult& Aws::APIGateway::Model::UpdateDomainNameResult::WithDistributionDomainName ( const Aws::String value)
inline

The domain name of the Amazon CloudFront distribution associated with this custom domain name for an edge-optimized endpoint. You set up this association when adding a DNS record pointing the custom domain name to this distribution name. For more information about CloudFront distributions, see the Amazon CloudFront documentation.

Definition at line 494 of file UpdateDomainNameResult.h.

◆ WithDistributionDomainName() [3/3]

UpdateDomainNameResult& Aws::APIGateway::Model::UpdateDomainNameResult::WithDistributionDomainName ( const char *  value)
inline

The domain name of the Amazon CloudFront distribution associated with this custom domain name for an edge-optimized endpoint. You set up this association when adding a DNS record pointing the custom domain name to this distribution name. For more information about CloudFront distributions, see the Amazon CloudFront documentation.

Definition at line 514 of file UpdateDomainNameResult.h.

◆ WithDistributionHostedZoneId() [1/3]

UpdateDomainNameResult& Aws::APIGateway::Model::UpdateDomainNameResult::WithDistributionHostedZoneId ( Aws::String &&  value)
inline

The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint. The valid value is Z2FDTNDATAQYW2 for all the regions. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.

Definition at line 581 of file UpdateDomainNameResult.h.

◆ WithDistributionHostedZoneId() [2/3]

UpdateDomainNameResult& Aws::APIGateway::Model::UpdateDomainNameResult::WithDistributionHostedZoneId ( const Aws::String value)
inline

The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint. The valid value is Z2FDTNDATAQYW2 for all the regions. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.

Definition at line 570 of file UpdateDomainNameResult.h.

◆ WithDistributionHostedZoneId() [3/3]

UpdateDomainNameResult& Aws::APIGateway::Model::UpdateDomainNameResult::WithDistributionHostedZoneId ( const char *  value)
inline

The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint. The valid value is Z2FDTNDATAQYW2 for all the regions. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.

Definition at line 592 of file UpdateDomainNameResult.h.

◆ WithDomainName() [1/3]

UpdateDomainNameResult& Aws::APIGateway::Model::UpdateDomainNameResult::WithDomainName ( Aws::String &&  value)
inline

The custom domain name as an API host name, for example, my-api.example.com.

Definition at line 92 of file UpdateDomainNameResult.h.

◆ WithDomainName() [2/3]

UpdateDomainNameResult& Aws::APIGateway::Model::UpdateDomainNameResult::WithDomainName ( const Aws::String value)
inline

The custom domain name as an API host name, for example, my-api.example.com.

Definition at line 86 of file UpdateDomainNameResult.h.

◆ WithDomainName() [3/3]

UpdateDomainNameResult& Aws::APIGateway::Model::UpdateDomainNameResult::WithDomainName ( const char *  value)
inline

The custom domain name as an API host name, for example, my-api.example.com.

Definition at line 98 of file UpdateDomainNameResult.h.

◆ WithDomainNameStatus() [1/2]

UpdateDomainNameResult& Aws::APIGateway::Model::UpdateDomainNameResult::WithDomainNameStatus ( const DomainNameStatus value)
inline

The status of the DomainName migration. The valid values are AVAILABLE and UPDATING. If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated.

Definition at line 660 of file UpdateDomainNameResult.h.

◆ WithDomainNameStatus() [2/2]

UpdateDomainNameResult& Aws::APIGateway::Model::UpdateDomainNameResult::WithDomainNameStatus ( DomainNameStatus &&  value)
inline

The status of the DomainName migration. The valid values are AVAILABLE and UPDATING. If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated.

Definition at line 669 of file UpdateDomainNameResult.h.

◆ WithDomainNameStatusMessage() [1/3]

UpdateDomainNameResult& Aws::APIGateway::Model::UpdateDomainNameResult::WithDomainNameStatusMessage ( Aws::String &&  value)
inline

An optional text message containing detailed information about status of the DomainName migration.

Definition at line 706 of file UpdateDomainNameResult.h.

◆ WithDomainNameStatusMessage() [2/3]

UpdateDomainNameResult& Aws::APIGateway::Model::UpdateDomainNameResult::WithDomainNameStatusMessage ( const Aws::String value)
inline

An optional text message containing detailed information about status of the DomainName migration.

Definition at line 700 of file UpdateDomainNameResult.h.

◆ WithDomainNameStatusMessage() [3/3]

UpdateDomainNameResult& Aws::APIGateway::Model::UpdateDomainNameResult::WithDomainNameStatusMessage ( const char *  value)
inline

An optional text message containing detailed information about status of the DomainName migration.

Definition at line 712 of file UpdateDomainNameResult.h.

◆ WithEndpointConfiguration() [1/2]

UpdateDomainNameResult& Aws::APIGateway::Model::UpdateDomainNameResult::WithEndpointConfiguration ( const EndpointConfiguration value)
inline

The endpoint configuration of this DomainName showing the endpoint types of the domain name.

Definition at line 617 of file UpdateDomainNameResult.h.

◆ WithEndpointConfiguration() [2/2]

UpdateDomainNameResult& Aws::APIGateway::Model::UpdateDomainNameResult::WithEndpointConfiguration ( EndpointConfiguration &&  value)
inline

The endpoint configuration of this DomainName showing the endpoint types of the domain name.

Definition at line 623 of file UpdateDomainNameResult.h.

◆ WithMutualTlsAuthentication() [1/2]

UpdateDomainNameResult& Aws::APIGateway::Model::UpdateDomainNameResult::WithMutualTlsAuthentication ( const MutualTlsAuthentication value)
inline

The mutual TLS authentication configuration for a custom domain name. If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.

Definition at line 850 of file UpdateDomainNameResult.h.

◆ WithMutualTlsAuthentication() [2/2]

UpdateDomainNameResult& Aws::APIGateway::Model::UpdateDomainNameResult::WithMutualTlsAuthentication ( MutualTlsAuthentication &&  value)
inline

The mutual TLS authentication configuration for a custom domain name. If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.

Definition at line 857 of file UpdateDomainNameResult.h.

◆ WithRegionalCertificateArn() [1/3]

UpdateDomainNameResult& Aws::APIGateway::Model::UpdateDomainNameResult::WithRegionalCertificateArn ( Aws::String &&  value)
inline

The reference to an AWS-managed certificate that will be used for validating the regional domain name. AWS Certificate Manager is the only supported source.

Definition at line 436 of file UpdateDomainNameResult.h.

◆ WithRegionalCertificateArn() [2/3]

UpdateDomainNameResult& Aws::APIGateway::Model::UpdateDomainNameResult::WithRegionalCertificateArn ( const Aws::String value)
inline

The reference to an AWS-managed certificate that will be used for validating the regional domain name. AWS Certificate Manager is the only supported source.

Definition at line 429 of file UpdateDomainNameResult.h.

◆ WithRegionalCertificateArn() [3/3]

UpdateDomainNameResult& Aws::APIGateway::Model::UpdateDomainNameResult::WithRegionalCertificateArn ( const char *  value)
inline

The reference to an AWS-managed certificate that will be used for validating the regional domain name. AWS Certificate Manager is the only supported source.

Definition at line 443 of file UpdateDomainNameResult.h.

◆ WithRegionalCertificateName() [1/3]

UpdateDomainNameResult& Aws::APIGateway::Model::UpdateDomainNameResult::WithRegionalCertificateName ( Aws::String &&  value)
inline

The name of the certificate that will be used for validating the regional domain name.

Definition at line 387 of file UpdateDomainNameResult.h.

◆ WithRegionalCertificateName() [2/3]

UpdateDomainNameResult& Aws::APIGateway::Model::UpdateDomainNameResult::WithRegionalCertificateName ( const Aws::String value)
inline

The name of the certificate that will be used for validating the regional domain name.

Definition at line 381 of file UpdateDomainNameResult.h.

◆ WithRegionalCertificateName() [3/3]

UpdateDomainNameResult& Aws::APIGateway::Model::UpdateDomainNameResult::WithRegionalCertificateName ( const char *  value)
inline

The name of the certificate that will be used for validating the regional domain name.

Definition at line 393 of file UpdateDomainNameResult.h.

◆ WithRegionalDomainName() [1/3]

UpdateDomainNameResult& Aws::APIGateway::Model::UpdateDomainNameResult::WithRegionalDomainName ( Aws::String &&  value)
inline

The domain name associated with the regional endpoint for this custom domain name. You set up this association by adding a DNS record that points the custom domain name to this regional domain name. The regional domain name is returned by API Gateway when you create a regional endpoint.

Definition at line 271 of file UpdateDomainNameResult.h.

◆ WithRegionalDomainName() [2/3]

UpdateDomainNameResult& Aws::APIGateway::Model::UpdateDomainNameResult::WithRegionalDomainName ( const Aws::String value)
inline

The domain name associated with the regional endpoint for this custom domain name. You set up this association by adding a DNS record that points the custom domain name to this regional domain name. The regional domain name is returned by API Gateway when you create a regional endpoint.

Definition at line 263 of file UpdateDomainNameResult.h.

◆ WithRegionalDomainName() [3/3]

UpdateDomainNameResult& Aws::APIGateway::Model::UpdateDomainNameResult::WithRegionalDomainName ( const char *  value)
inline

The domain name associated with the regional endpoint for this custom domain name. You set up this association by adding a DNS record that points the custom domain name to this regional domain name. The regional domain name is returned by API Gateway when you create a regional endpoint.

Definition at line 279 of file UpdateDomainNameResult.h.

◆ WithRegionalHostedZoneId() [1/3]

UpdateDomainNameResult& Aws::APIGateway::Model::UpdateDomainNameResult::WithRegionalHostedZoneId ( Aws::String &&  value)
inline

The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.

Definition at line 340 of file UpdateDomainNameResult.h.

◆ WithRegionalHostedZoneId() [2/3]

UpdateDomainNameResult& Aws::APIGateway::Model::UpdateDomainNameResult::WithRegionalHostedZoneId ( const Aws::String value)
inline

The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.

Definition at line 330 of file UpdateDomainNameResult.h.

◆ WithRegionalHostedZoneId() [3/3]

UpdateDomainNameResult& Aws::APIGateway::Model::UpdateDomainNameResult::WithRegionalHostedZoneId ( const char *  value)
inline

The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.

Definition at line 350 of file UpdateDomainNameResult.h.

◆ WithSecurityPolicy() [1/2]

UpdateDomainNameResult& Aws::APIGateway::Model::UpdateDomainNameResult::WithSecurityPolicy ( const SecurityPolicy value)
inline

The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are TLS_1_0 and TLS_1_2.

Definition at line 741 of file UpdateDomainNameResult.h.

◆ WithSecurityPolicy() [2/2]

UpdateDomainNameResult& Aws::APIGateway::Model::UpdateDomainNameResult::WithSecurityPolicy ( SecurityPolicy &&  value)
inline

The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are TLS_1_0 and TLS_1_2.

Definition at line 748 of file UpdateDomainNameResult.h.

◆ WithTags() [1/2]

UpdateDomainNameResult& Aws::APIGateway::Model::UpdateDomainNameResult::WithTags ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

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

Definition at line 779 of file UpdateDomainNameResult.h.

◆ WithTags() [2/2]

UpdateDomainNameResult& Aws::APIGateway::Model::UpdateDomainNameResult::WithTags ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

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

Definition at line 773 of file UpdateDomainNameResult.h.


The documentation for this class was generated from the following file: