Class: Aws::APIGateway::Types::DomainName

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-apigateway/types.rb

Overview

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

<div class=“Remarks” markdown=“1”> 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 `apis.examples.com/myApi`, where `myApi` is the base path mapping (BasePathMapping) of your API under the custom domain name.

</div>

<div class=“seeAlso”>

Set a Custom Host Name for an API][1

</div>

[1]: docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html

Instance Attribute Summary collapse

Instance Attribute Details

#certificate_arn ⇒ String

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.

Returns:

  • (String) 


2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
 
# File 'lib/aws-sdk-apigateway/types.rb', line 2422

class DomainName < Struct.new(
  :domain_name,
  :certificate_name,
  :certificate_arn,
  :certificate_upload_date,
  :regional_domain_name,
  :regional_hosted_zone_id,
  :regional_certificate_name,
  :regional_certificate_arn,
  :distribution_domain_name,
  :distribution_hosted_zone_id,
  :endpoint_configuration)
  include Aws::Structure
end

#certificate_name ⇒ String

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

Returns:

  • (String) 


2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
 
# File 'lib/aws-sdk-apigateway/types.rb', line 2422

class DomainName < Struct.new(
  :domain_name,
  :certificate_name,
  :certificate_arn,
  :certificate_upload_date,
  :regional_domain_name,
  :regional_hosted_zone_id,
  :regional_certificate_name,
  :regional_certificate_arn,
  :distribution_domain_name,
  :distribution_hosted_zone_id,
  :endpoint_configuration)
  include Aws::Structure
end

#certificate_upload_date ⇒ Time

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

Returns:

  • (Time) 


2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
 
# File 'lib/aws-sdk-apigateway/types.rb', line 2422

class DomainName < Struct.new(
  :domain_name,
  :certificate_name,
  :certificate_arn,
  :certificate_upload_date,
  :regional_domain_name,
  :regional_hosted_zone_id,
  :regional_certificate_name,
  :regional_certificate_arn,
  :distribution_domain_name,
  :distribution_hosted_zone_id,
  :endpoint_configuration)
  include Aws::Structure
end

#distribution_domain_name ⇒ String

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].

[1]: aws.amazon.com/documentation/cloudfront/

Returns:

  • (String) 


2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
 
# File 'lib/aws-sdk-apigateway/types.rb', line 2422

class DomainName < Struct.new(
  :domain_name,
  :certificate_name,
  :certificate_arn,
  :certificate_upload_date,
  :regional_domain_name,
  :regional_hosted_zone_id,
  :regional_certificate_name,
  :regional_certificate_arn,
  :distribution_domain_name,
  :distribution_hosted_zone_id,
  :endpoint_configuration)
  include Aws::Structure
end

#distribution_hosted_zone_id ⇒ String

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].

[1]: docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-regional-api-custom-domain-create.html [2]: docs.aws.amazon.com/general/latest/gr/rande.html#apigateway_region

Returns:

  • (String) 


2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
 
# File 'lib/aws-sdk-apigateway/types.rb', line 2422

class DomainName < Struct.new(
  :domain_name,
  :certificate_name,
  :certificate_arn,
  :certificate_upload_date,
  :regional_domain_name,
  :regional_hosted_zone_id,
  :regional_certificate_name,
  :regional_certificate_arn,
  :distribution_domain_name,
  :distribution_hosted_zone_id,
  :endpoint_configuration)
  include Aws::Structure
end

#domain_name ⇒ String

The name of the DomainName resource.

Returns:

  • (String) 


2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
 
# File 'lib/aws-sdk-apigateway/types.rb', line 2422

class DomainName < Struct.new(
  :domain_name,
  :certificate_name,
  :certificate_arn,
  :certificate_upload_date,
  :regional_domain_name,
  :regional_hosted_zone_id,
  :regional_certificate_name,
  :regional_certificate_arn,
  :distribution_domain_name,
  :distribution_hosted_zone_id,
  :endpoint_configuration)
  include Aws::Structure
end

#endpoint_configuration ⇒ Types::EndpointConfiguration

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

Returns:



2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
 
# File 'lib/aws-sdk-apigateway/types.rb', line 2422

class DomainName < Struct.new(
  :domain_name,
  :certificate_name,
  :certificate_arn,
  :certificate_upload_date,
  :regional_domain_name,
  :regional_hosted_zone_id,
  :regional_certificate_name,
  :regional_certificate_arn,
  :distribution_domain_name,
  :distribution_hosted_zone_id,
  :endpoint_configuration)
  include Aws::Structure
end

#regional_certificate_arn ⇒ String

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.

Returns:

  • (String) 


2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
 
# File 'lib/aws-sdk-apigateway/types.rb', line 2422

class DomainName < Struct.new(
  :domain_name,
  :certificate_name,
  :certificate_arn,
  :certificate_upload_date,
  :regional_domain_name,
  :regional_hosted_zone_id,
  :regional_certificate_name,
  :regional_certificate_arn,
  :distribution_domain_name,
  :distribution_hosted_zone_id,
  :endpoint_configuration)
  include Aws::Structure
end

#regional_certificate_name ⇒ String

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

Returns:

  • (String) 


2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
 
# File 'lib/aws-sdk-apigateway/types.rb', line 2422

class DomainName < Struct.new(
  :domain_name,
  :certificate_name,
  :certificate_arn,
  :certificate_upload_date,
  :regional_domain_name,
  :regional_hosted_zone_id,
  :regional_certificate_name,
  :regional_certificate_arn,
  :distribution_domain_name,
  :distribution_hosted_zone_id,
  :endpoint_configuration)
  include Aws::Structure
end

#regional_domain_name ⇒ String

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.

Returns:

  • (String) 


2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
 
# File 'lib/aws-sdk-apigateway/types.rb', line 2422

class DomainName < Struct.new(
  :domain_name,
  :certificate_name,
  :certificate_arn,
  :certificate_upload_date,
  :regional_domain_name,
  :regional_hosted_zone_id,
  :regional_certificate_name,
  :regional_certificate_arn,
  :distribution_domain_name,
  :distribution_hosted_zone_id,
  :endpoint_configuration)
  include Aws::Structure
end

#regional_hosted_zone_id ⇒ String

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].

[1]: docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-regional-api-custom-domain-create.html [2]: docs.aws.amazon.com/general/latest/gr/rande.html#apigateway_region

Returns:

  • (String) 


2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
 
# File 'lib/aws-sdk-apigateway/types.rb', line 2422

class DomainName < Struct.new(
  :domain_name,
  :certificate_name,
  :certificate_arn,
  :certificate_upload_date,
  :regional_domain_name,
  :regional_hosted_zone_id,
  :regional_certificate_name,
  :regional_certificate_arn,
  :distribution_domain_name,
  :distribution_hosted_zone_id,
  :endpoint_configuration)
  include Aws::Structure
end