Docs Packages
  1. Packages
  2. AWS Native
  3. API Docs
  4. apigateway
  5. getDomainName

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.apigateway.getDomainName

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws-native

    Resource Type definition for AWS::ApiGateway::DomainName.

    Using getDomainName

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getDomainName(args: GetDomainNameArgs, opts?: InvokeOptions): Promise<GetDomainNameResult>
function getDomainNameOutput(args: GetDomainNameOutputArgs, opts?: InvokeOptions): Output<GetDomainNameResult>
    def get_domain_name(domain_name: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetDomainNameResult
def get_domain_name_output(domain_name: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetDomainNameResult]
    func LookupDomainName(ctx *Context, args *LookupDomainNameArgs, opts ...InvokeOption) (*LookupDomainNameResult, error)
func LookupDomainNameOutput(ctx *Context, args *LookupDomainNameOutputArgs, opts ...InvokeOption) LookupDomainNameResultOutput

    > Note: This function is named LookupDomainName in the Go SDK.

    public static class GetDomainName 
{
    public static Task<GetDomainNameResult> InvokeAsync(GetDomainNameArgs args, InvokeOptions? opts = null)
    public static Output<GetDomainNameResult> Invoke(GetDomainNameInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetDomainNameResult> getDomainName(GetDomainNameArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: aws-native:apigateway:getDomainName
  arguments:
    # arguments dictionary

    The following arguments are supported:

    DomainNameValue string
    The custom domain name as an API host name, for example, my-api.example.com .
    DomainName string
    The custom domain name as an API host name, for example, my-api.example.com .
    domainName String
    The custom domain name as an API host name, for example, my-api.example.com .
    domainName string
    The custom domain name as an API host name, for example, my-api.example.com .
    domain_name str
    The custom domain name as an API host name, for example, my-api.example.com .
    domainName String
    The custom domain name as an API host name, for example, my-api.example.com .

    getDomainName Result

    The following output properties are available:

    CertificateArn 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.
    DistributionDomainName string

    The Amazon CloudFront distribution domain name that's mapped to the custom domain name. This is only applicable for endpoints whose type is EDGE .

    Example: d111111abcdef8.cloudfront.net

    DistributionHostedZoneId string
    The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint. The only valid value is Z2FDTNDATAQYW2 for all regions.
    EndpointConfiguration Pulumi.AwsNative.ApiGateway.Outputs.DomainNameEndpointConfiguration
    The endpoint configuration of this DomainName showing the endpoint types of the domain name.
    MutualTlsAuthentication Pulumi.AwsNative.ApiGateway.Outputs.DomainNameMutualTlsAuthentication
    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.
    OwnershipVerificationCertificateArn string
    The ARN of the public certificate issued by ACM to validate ownership of your custom domain. Only required when configuring mutual TLS and using an ACM imported or private CA certificate ARN as the RegionalCertificateArn.
    RegionalCertificateArn 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.
    RegionalDomainName 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.
    RegionalHostedZoneId string
    The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint.
    SecurityPolicy string
    The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are TLS_1_0 and TLS_1_2 .
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    The collection of tags. Each tag element is associated with a given resource.
    CertificateArn 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.
    DistributionDomainName string

    The Amazon CloudFront distribution domain name that's mapped to the custom domain name. This is only applicable for endpoints whose type is EDGE .

    Example: d111111abcdef8.cloudfront.net

    DistributionHostedZoneId string
    The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint. The only valid value is Z2FDTNDATAQYW2 for all regions.
    EndpointConfiguration DomainNameEndpointConfiguration
    The endpoint configuration of this DomainName showing the endpoint types of the domain name.
    MutualTlsAuthentication DomainNameMutualTlsAuthentication
    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.
    OwnershipVerificationCertificateArn string
    The ARN of the public certificate issued by ACM to validate ownership of your custom domain. Only required when configuring mutual TLS and using an ACM imported or private CA certificate ARN as the RegionalCertificateArn.
    RegionalCertificateArn 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.
    RegionalDomainName 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.
    RegionalHostedZoneId string
    The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint.
    SecurityPolicy string
    The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are TLS_1_0 and TLS_1_2 .
    Tags Tag
    The collection of tags. Each tag element is associated with a given resource.
    certificateArn 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.
    distributionDomainName String

    The Amazon CloudFront distribution domain name that's mapped to the custom domain name. This is only applicable for endpoints whose type is EDGE .

    Example: d111111abcdef8.cloudfront.net

    distributionHostedZoneId String
    The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint. The only valid value is Z2FDTNDATAQYW2 for all regions.
    endpointConfiguration DomainNameEndpointConfiguration
    The endpoint configuration of this DomainName showing the endpoint types of the domain name.
    mutualTlsAuthentication DomainNameMutualTlsAuthentication
    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.
    ownershipVerificationCertificateArn String
    The ARN of the public certificate issued by ACM to validate ownership of your custom domain. Only required when configuring mutual TLS and using an ACM imported or private CA certificate ARN as the RegionalCertificateArn.
    regionalCertificateArn 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.
    regionalDomainName 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.
    regionalHostedZoneId String
    The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint.
    securityPolicy String
    The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are TLS_1_0 and TLS_1_2 .
    tags List<Tag>
    The collection of tags. Each tag element is associated with a given resource.
    certificateArn 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.
    distributionDomainName string

    The Amazon CloudFront distribution domain name that's mapped to the custom domain name. This is only applicable for endpoints whose type is EDGE .

    Example: d111111abcdef8.cloudfront.net

    distributionHostedZoneId string
    The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint. The only valid value is Z2FDTNDATAQYW2 for all regions.
    endpointConfiguration DomainNameEndpointConfiguration
    The endpoint configuration of this DomainName showing the endpoint types of the domain name.
    mutualTlsAuthentication DomainNameMutualTlsAuthentication
    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.
    ownershipVerificationCertificateArn string
    The ARN of the public certificate issued by ACM to validate ownership of your custom domain. Only required when configuring mutual TLS and using an ACM imported or private CA certificate ARN as the RegionalCertificateArn.
    regionalCertificateArn 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.
    regionalDomainName 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.
    regionalHostedZoneId string
    The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint.
    securityPolicy string
    The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are TLS_1_0 and TLS_1_2 .
    tags Tag[]
    The collection of tags. Each tag element is associated with a given resource.
    certificate_arn str
    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.
    distribution_domain_name str

    The Amazon CloudFront distribution domain name that's mapped to the custom domain name. This is only applicable for endpoints whose type is EDGE .

    Example: d111111abcdef8.cloudfront.net

    distribution_hosted_zone_id str
    The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint. The only valid value is Z2FDTNDATAQYW2 for all regions.
    endpoint_configuration DomainNameEndpointConfiguration
    The endpoint configuration of this DomainName showing the endpoint types of the domain name.
    mutual_tls_authentication DomainNameMutualTlsAuthentication
    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.
    ownership_verification_certificate_arn str
    The ARN of the public certificate issued by ACM to validate ownership of your custom domain. Only required when configuring mutual TLS and using an ACM imported or private CA certificate ARN as the RegionalCertificateArn.
    regional_certificate_arn str
    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.
    regional_domain_name str
    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.
    regional_hosted_zone_id str
    The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint.
    security_policy str
    The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are TLS_1_0 and TLS_1_2 .
    tags Sequence[root_Tag]
    The collection of tags. Each tag element is associated with a given resource.
    certificateArn 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.
    distributionDomainName String

    The Amazon CloudFront distribution domain name that's mapped to the custom domain name. This is only applicable for endpoints whose type is EDGE .

    Example: d111111abcdef8.cloudfront.net

    distributionHostedZoneId String
    The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint. The only valid value is Z2FDTNDATAQYW2 for all regions.
    endpointConfiguration Property Map
    The endpoint configuration of this DomainName showing the endpoint types of the domain name.
    mutualTlsAuthentication Property Map
    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.
    ownershipVerificationCertificateArn String
    The ARN of the public certificate issued by ACM to validate ownership of your custom domain. Only required when configuring mutual TLS and using an ACM imported or private CA certificate ARN as the RegionalCertificateArn.
    regionalCertificateArn 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.
    regionalDomainName 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.
    regionalHostedZoneId String
    The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint.
    securityPolicy String
    The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are TLS_1_0 and TLS_1_2 .
    tags List<Property Map>
    The collection of tags. Each tag element is associated with a given resource.

    Supporting Types

    DomainNameEndpointConfiguration

    Types List<string>
    A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an edge-optimized API and its custom domain name, the endpoint type is "EDGE" . For a regional API and its custom domain name, the endpoint type is REGIONAL . For a private API, the endpoint type is PRIVATE .
    Types []string
    A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an edge-optimized API and its custom domain name, the endpoint type is "EDGE" . For a regional API and its custom domain name, the endpoint type is REGIONAL . For a private API, the endpoint type is PRIVATE .
    types List<String>
    A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an edge-optimized API and its custom domain name, the endpoint type is "EDGE" . For a regional API and its custom domain name, the endpoint type is REGIONAL . For a private API, the endpoint type is PRIVATE .
    types string[]
    A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an edge-optimized API and its custom domain name, the endpoint type is "EDGE" . For a regional API and its custom domain name, the endpoint type is REGIONAL . For a private API, the endpoint type is PRIVATE .
    types Sequence[str]
    A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an edge-optimized API and its custom domain name, the endpoint type is "EDGE" . For a regional API and its custom domain name, the endpoint type is REGIONAL . For a private API, the endpoint type is PRIVATE .
    types List<String>
    A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an edge-optimized API and its custom domain name, the endpoint type is "EDGE" . For a regional API and its custom domain name, the endpoint type is REGIONAL . For a private API, the endpoint type is PRIVATE .

    DomainNameMutualTlsAuthentication

    TruststoreUri string
    An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example s3://bucket-name/key-name . The truststore can contain certificates from public or private certificate authorities. To update the truststore, upload a new version to S3, and then update your custom domain name to use the new version. To update the truststore, you must have permissions to access the S3 object.
    TruststoreVersion string
    The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket.
    TruststoreUri string
    An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example s3://bucket-name/key-name . The truststore can contain certificates from public or private certificate authorities. To update the truststore, upload a new version to S3, and then update your custom domain name to use the new version. To update the truststore, you must have permissions to access the S3 object.
    TruststoreVersion string
    The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket.
    truststoreUri String
    An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example s3://bucket-name/key-name . The truststore can contain certificates from public or private certificate authorities. To update the truststore, upload a new version to S3, and then update your custom domain name to use the new version. To update the truststore, you must have permissions to access the S3 object.
    truststoreVersion String
    The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket.
    truststoreUri string
    An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example s3://bucket-name/key-name . The truststore can contain certificates from public or private certificate authorities. To update the truststore, upload a new version to S3, and then update your custom domain name to use the new version. To update the truststore, you must have permissions to access the S3 object.
    truststoreVersion string
    The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket.
    truststore_uri str
    An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example s3://bucket-name/key-name . The truststore can contain certificates from public or private certificate authorities. To update the truststore, upload a new version to S3, and then update your custom domain name to use the new version. To update the truststore, you must have permissions to access the S3 object.
    truststore_version str
    The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket.
    truststoreUri String
    An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example s3://bucket-name/key-name . The truststore can contain certificates from public or private certificate authorities. To update the truststore, upload a new version to S3, and then update your custom domain name to use the new version. To update the truststore, you must have permissions to access the S3 object.
    truststoreVersion String
    The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket.

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
    pulumi/pulumi-aws-native