1. Packages
  2. AWS Native
  3. API Docs
  4. apigatewayv2
  5. DomainName

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

AWS Native v0.111.0 published on Tuesday, Jul 9, 2024 by Pulumi

aws-native.apigatewayv2.DomainName

Explore with Pulumi AI

aws-native logo

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

AWS Native v0.111.0 published on Tuesday, Jul 9, 2024 by Pulumi

    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.

    Create DomainName Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new DomainName(name: string, args: DomainNameArgs, opts?: CustomResourceOptions);
    @overload
    def DomainName(resource_name: str,
                   args: DomainNameArgs,
                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def DomainName(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   domain_name: Optional[str] = None,
                   domain_name_configurations: Optional[Sequence[DomainNameConfigurationArgs]] = None,
                   mutual_tls_authentication: Optional[DomainNameMutualTlsAuthenticationArgs] = None,
                   tags: Optional[Mapping[str, str]] = None)
    func NewDomainName(ctx *Context, name string, args DomainNameArgs, opts ...ResourceOption) (*DomainName, error)
    public DomainName(string name, DomainNameArgs args, CustomResourceOptions? opts = null)
    public DomainName(String name, DomainNameArgs args)
    public DomainName(String name, DomainNameArgs args, CustomResourceOptions options)
    
    type: aws-native:apigatewayv2:DomainName
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args DomainNameArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args DomainNameArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args DomainNameArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DomainNameArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DomainNameArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    DomainName Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The DomainName resource accepts the following input properties:

    DomainNameValue string
    The custom domain name for your API in Amazon API Gateway. Uppercase letters are not supported.
    DomainNameConfigurations List<Pulumi.AwsNative.ApiGatewayV2.Inputs.DomainNameConfiguration>
    The domain name configurations.
    MutualTlsAuthentication Pulumi.AwsNative.ApiGatewayV2.Inputs.DomainNameMutualTlsAuthentication
    The mutual TLS authentication configuration for a custom domain name.
    Tags Dictionary<string, string>
    The collection of tags associated with a domain name.
    DomainName string
    The custom domain name for your API in Amazon API Gateway. Uppercase letters are not supported.
    DomainNameConfigurations []DomainNameConfigurationArgs
    The domain name configurations.
    MutualTlsAuthentication DomainNameMutualTlsAuthenticationArgs
    The mutual TLS authentication configuration for a custom domain name.
    Tags map[string]string
    The collection of tags associated with a domain name.
    domainName String
    The custom domain name for your API in Amazon API Gateway. Uppercase letters are not supported.
    domainNameConfigurations List<DomainNameConfiguration>
    The domain name configurations.
    mutualTlsAuthentication DomainNameMutualTlsAuthentication
    The mutual TLS authentication configuration for a custom domain name.
    tags Map<String,String>
    The collection of tags associated with a domain name.
    domainName string
    The custom domain name for your API in Amazon API Gateway. Uppercase letters are not supported.
    domainNameConfigurations DomainNameConfiguration[]
    The domain name configurations.
    mutualTlsAuthentication DomainNameMutualTlsAuthentication
    The mutual TLS authentication configuration for a custom domain name.
    tags {[key: string]: string}
    The collection of tags associated with a domain name.
    domain_name str
    The custom domain name for your API in Amazon API Gateway. Uppercase letters are not supported.
    domain_name_configurations Sequence[DomainNameConfigurationArgs]
    The domain name configurations.
    mutual_tls_authentication DomainNameMutualTlsAuthenticationArgs
    The mutual TLS authentication configuration for a custom domain name.
    tags Mapping[str, str]
    The collection of tags associated with a domain name.
    domainName String
    The custom domain name for your API in Amazon API Gateway. Uppercase letters are not supported.
    domainNameConfigurations List<Property Map>
    The domain name configurations.
    mutualTlsAuthentication Property Map
    The mutual TLS authentication configuration for a custom domain name.
    tags Map<String>
    The collection of tags associated with a domain name.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the DomainName resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    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.
    Id string
    The provider-assigned unique ID for this managed resource.
    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.
    id String
    The provider-assigned unique ID for this managed resource.
    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.
    id string
    The provider-assigned unique ID for this managed resource.
    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.
    id str
    The provider-assigned unique ID for this managed resource.
    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.
    id String
    The provider-assigned unique ID for this managed resource.
    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.

    Supporting Types

    DomainNameConfiguration, DomainNameConfigurationArgs

    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, DomainNameMutualTlsAuthenticationArgs

    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

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

    AWS Native v0.111.0 published on Tuesday, Jul 9, 2024 by Pulumi