Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Native
  3. API Docs
  4. apigatewayv2
  5. getDomainName

We recommend new projects start with resources from the AWS provider.

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.apigatewayv2.getDomainName

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
pulumi/pulumi-aws-native

    The AWS::ApiGatewayV2::DomainName resource specifies a custom domain name for your API in Amazon API Gateway (API Gateway). You can use a custom domain name to provide a URL that’s more intuitive and easier to recall. For more information about using custom domain names, see Set up Custom Domain Name for an API in API Gateway in the API Gateway Developer Guide.

    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:apigatewayv2:getDomainName
  arguments:
    # arguments dictionary

    The following arguments are supported:

    DomainNameValue string
    The custom domain name for your API in Amazon API Gateway. Uppercase letters are not supported.
    DomainName string
    The custom domain name for your API in Amazon API Gateway. Uppercase letters are not supported.
    domainName String
    The custom domain name for your API in Amazon API Gateway. Uppercase letters are not supported.
    domainName string
    The custom domain name for your API in Amazon API Gateway. Uppercase letters are not supported.
    domain_name str
    The custom domain name for your API in Amazon API Gateway. Uppercase letters are not supported.
    domainName String
    The custom domain name for your API in Amazon API Gateway. Uppercase letters are not supported.

    getDomainName Result

    The following output properties are available:

    DomainNameConfigurations List<Pulumi.AwsNative.ApiGatewayV2.Outputs.DomainNameConfiguration>
    The domain name configurations.
    MutualTlsAuthentication Pulumi.AwsNative.ApiGatewayV2.Outputs.DomainNameMutualTlsAuthentication
    The mutual TLS authentication configuration for a custom domain name.
    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.
    Tags Dictionary<string, string>
    The collection of tags associated with a domain name.
    DomainNameConfigurations []DomainNameConfiguration
    The domain name configurations.
    MutualTlsAuthentication DomainNameMutualTlsAuthentication
    The mutual TLS authentication configuration for a custom domain name.
    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.
    Tags map[string]string
    The collection of tags associated with a domain name.
    domainNameConfigurations List<DomainNameConfiguration>
    The domain name configurations.
    mutualTlsAuthentication DomainNameMutualTlsAuthentication
    The mutual TLS authentication configuration for a custom domain name.
    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.
    tags Map<String,String>
    The collection of tags associated with a domain name.
    domainNameConfigurations DomainNameConfiguration[]
    The domain name configurations.
    mutualTlsAuthentication DomainNameMutualTlsAuthentication
    The mutual TLS authentication configuration for a custom domain name.
    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.
    tags {[key: string]: string}
    The collection of tags associated with a domain name.
    domain_name_configurations Sequence[DomainNameConfiguration]
    The domain name configurations.
    mutual_tls_authentication DomainNameMutualTlsAuthentication
    The mutual TLS authentication configuration for a custom domain name.
    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.
    tags Mapping[str, str]
    The collection of tags associated with a domain name.
    domainNameConfigurations List<Property Map>
    The domain name configurations.
    mutualTlsAuthentication Property Map
    The mutual TLS authentication configuration for a custom domain name.
    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.
    tags Map<String>
    The collection of tags associated with a domain name.

    Supporting Types

    DomainNameConfiguration

    CertificateArn string
    An AWS-managed certificate that will be used by the edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.
    CertificateName string
    The user-friendly name of the certificate that will be used by the edge-optimized endpoint for this domain name.
    EndpointType string
    The endpoint type.
    OwnershipVerificationCertificateArn string
    The Amazon resource name (ARN) for the public certificate issued by ACMlong. This ARN is used to validate custom domain ownership. It's required only if you configure mutual TLS and use either an ACM-imported or a private CA certificate ARN as the regionalCertificateArn.
    SecurityPolicy string
    The Transport Layer Security (TLS) version of the security policy for this domain name. The valid values are TLS_1_0 and TLS_1_2.
    CertificateArn string
    An AWS-managed certificate that will be used by the edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.
    CertificateName string
    The user-friendly name of the certificate that will be used by the edge-optimized endpoint for this domain name.
    EndpointType string
    The endpoint type.
    OwnershipVerificationCertificateArn string
    The Amazon resource name (ARN) for the public certificate issued by ACMlong. This ARN is used to validate custom domain ownership. It's required only if you configure mutual TLS and use either an ACM-imported or a private CA certificate ARN as the regionalCertificateArn.
    SecurityPolicy string
    The Transport Layer Security (TLS) version of the security policy for this domain name. The valid values are TLS_1_0 and TLS_1_2.
    certificateArn String
    An AWS-managed certificate that will be used by the edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.
    certificateName String
    The user-friendly name of the certificate that will be used by the edge-optimized endpoint for this domain name.
    endpointType String
    The endpoint type.
    ownershipVerificationCertificateArn String
    The Amazon resource name (ARN) for the public certificate issued by ACMlong. This ARN is used to validate custom domain ownership. It's required only if you configure mutual TLS and use either an ACM-imported or a private CA certificate ARN as the regionalCertificateArn.
    securityPolicy String
    The Transport Layer Security (TLS) version of the security policy for this domain name. The valid values are TLS_1_0 and TLS_1_2.
    certificateArn string
    An AWS-managed certificate that will be used by the edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.
    certificateName string
    The user-friendly name of the certificate that will be used by the edge-optimized endpoint for this domain name.
    endpointType string
    The endpoint type.
    ownershipVerificationCertificateArn string
    The Amazon resource name (ARN) for the public certificate issued by ACMlong. This ARN is used to validate custom domain ownership. It's required only if you configure mutual TLS and use either an ACM-imported or a private CA certificate ARN as the regionalCertificateArn.
    securityPolicy string
    The Transport Layer Security (TLS) version of the security policy for this domain name. The valid values are TLS_1_0 and TLS_1_2.
    certificate_arn str
    An AWS-managed certificate that will be used by the edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.
    certificate_name str
    The user-friendly name of the certificate that will be used by the edge-optimized endpoint for this domain name.
    endpoint_type str
    The endpoint type.
    ownership_verification_certificate_arn str
    The Amazon resource name (ARN) for the public certificate issued by ACMlong. This ARN is used to validate custom domain ownership. It's required only if you configure mutual TLS and use either an ACM-imported or a private CA certificate ARN as the regionalCertificateArn.
    security_policy str
    The Transport Layer Security (TLS) version of the security policy for this domain name. The valid values are TLS_1_0 and TLS_1_2.
    certificateArn String
    An AWS-managed certificate that will be used by the edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.
    certificateName String
    The user-friendly name of the certificate that will be used by the edge-optimized endpoint for this domain name.
    endpointType String
    The endpoint type.
    ownershipVerificationCertificateArn String
    The Amazon resource name (ARN) for the public certificate issued by ACMlong. This ARN is used to validate custom domain ownership. It's required only if you configure mutual TLS and use either an ACM-imported or a private CA certificate ARN as the regionalCertificateArn.
    securityPolicy String
    The Transport Layer Security (TLS) version of the security policy for this domain name. The valid values are TLS_1_0 and TLS_1_2.

    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.

    Package Details

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

    We recommend new projects start with resources from the AWS provider.

    AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
    pulumi/pulumi-aws-native