AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

DomainName

import "github.com/aws/aws-sdk-go/service/apigateway"

type DomainName struct { CertificateArn *string `locationName:"certificateArn" type:"string"` CertificateName *string `locationName:"certificateName" type:"string"` CertificateUploadDate *time.Time `locationName:"certificateUploadDate" type:"timestamp"` DistributionDomainName *string `locationName:"distributionDomainName" type:"string"` DistributionHostedZoneId *string `locationName:"distributionHostedZoneId" type:"string"` DomainName *string `locationName:"domainName" type:"string"` EndpointConfiguration *EndpointConfiguration `locationName:"endpointConfiguration" type:"structure"` RegionalCertificateArn *string `locationName:"regionalCertificateArn" type:"string"` RegionalCertificateName *string `locationName:"regionalCertificateName" type:"string"` RegionalDomainName *string `locationName:"regionalDomainName" type:"string"` RegionalHostedZoneId *string `locationName:"regionalHostedZoneId" type:"string"` }

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.

Set a Custom Host Name for an API (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html)

CertificateArn

Type: *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.

CertificateName

Type: *string

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

CertificateUploadDate

Type: *time.Time

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

DistributionDomainName

Type: *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 (https://aws.amazon.com/documentation/cloudfront/).

DistributionHostedZoneId

Type: *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 (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-regional-api-custom-domain-create.html) and AWS Regions and Endpoints for API Gateway (https://docs.aws.amazon.com/general/latest/gr/rande.html#apigateway_region).

DomainName

Type: *string

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

EndpointConfiguration

The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has.

RegionalCertificateArn

Type: *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.

RegionalCertificateName

Type: *string

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

RegionalDomainName

Type: *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.

RegionalHostedZoneId

Type: *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 (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-regional-api-custom-domain-create.html) and AWS Regions and Endpoints for API Gateway (https://docs.aws.amazon.com/general/latest/gr/rande.html#apigateway_region).

Method

GoString

func (s DomainName) GoString() string

GoString returns the string representation

SetCertificateArn

func (s *DomainName) SetCertificateArn(v string) *DomainName

SetCertificateArn sets the CertificateArn field's value.

SetCertificateName

func (s *DomainName) SetCertificateName(v string) *DomainName

SetCertificateName sets the CertificateName field's value.

SetCertificateUploadDate

func (s *DomainName) SetCertificateUploadDate(v time.Time) *DomainName

SetCertificateUploadDate sets the CertificateUploadDate field's value.

SetDistributionDomainName

func (s *DomainName) SetDistributionDomainName(v string) *DomainName

SetDistributionDomainName sets the DistributionDomainName field's value.

SetDistributionHostedZoneId

func (s *DomainName) SetDistributionHostedZoneId(v string) *DomainName

SetDistributionHostedZoneId sets the DistributionHostedZoneId field's value.

SetDomainName

func (s *DomainName) SetDomainName(v string) *DomainName

SetDomainName sets the DomainName field's value.

SetEndpointConfiguration

func (s *DomainName) SetEndpointConfiguration(v *EndpointConfiguration) *DomainName

SetEndpointConfiguration sets the EndpointConfiguration field's value.

SetRegionalCertificateArn

func (s *DomainName) SetRegionalCertificateArn(v string) *DomainName

SetRegionalCertificateArn sets the RegionalCertificateArn field's value.

SetRegionalCertificateName

func (s *DomainName) SetRegionalCertificateName(v string) *DomainName

SetRegionalCertificateName sets the RegionalCertificateName field's value.

SetRegionalDomainName

func (s *DomainName) SetRegionalDomainName(v string) *DomainName

SetRegionalDomainName sets the RegionalDomainName field's value.

SetRegionalHostedZoneId

func (s *DomainName) SetRegionalHostedZoneId(v string) *DomainName

SetRegionalHostedZoneId sets the RegionalHostedZoneId field's value.

String

func (s DomainName) String() string

String returns the string representation

On this page: