1. Pulumi Registry
  2. AWS Classic
  3. API Docs
  4. apigatewayv2
  5. DomainName
aws logo
AWS Classic v5.34.0, Mar 30 23

aws.apigatewayv2.DomainName

Manages an Amazon API Gateway Version 2 domain name. More information can be found in the Amazon API Gateway Developer Guide.

Note: This resource establishes ownership of and the TLS settings for a particular domain name. An API stage can be associated with the domain name using the aws.apigatewayv2.ApiMapping resource.

Example Usage

Basic

using System.Collections.Generic;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.ApiGatewayV2.DomainName("example", new()
    {
        Domain = "ws-api.example.com",
        DomainNameConfiguration = new Aws.ApiGatewayV2.Inputs.DomainNameDomainNameConfigurationArgs
        {
            CertificateArn = aws_acm_certificate.Example.Arn,
            EndpointType = "REGIONAL",
            SecurityPolicy = "TLS_1_2",
        },
    });

});

package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/apigatewayv2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := apigatewayv2.NewDomainName(ctx, "example", &apigatewayv2.DomainNameArgs{
			DomainName: pulumi.String("ws-api.example.com"),
			DomainNameConfiguration: &apigatewayv2.DomainNameDomainNameConfigurationArgs{
				CertificateArn: pulumi.Any(aws_acm_certificate.Example.Arn),
				EndpointType:   pulumi.String("REGIONAL"),
				SecurityPolicy: pulumi.String("TLS_1_2"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.apigatewayv2.DomainName;
import com.pulumi.aws.apigatewayv2.DomainNameArgs;
import com.pulumi.aws.apigatewayv2.inputs.DomainNameDomainNameConfigurationArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new DomainName("example", DomainNameArgs.builder()        
            .domainName("ws-api.example.com")
            .domainNameConfiguration(DomainNameDomainNameConfigurationArgs.builder()
                .certificateArn(aws_acm_certificate.example().arn())
                .endpointType("REGIONAL")
                .securityPolicy("TLS_1_2")
                .build())
            .build());

    }
}

import pulumi
import pulumi_aws as aws

example = aws.apigatewayv2.DomainName("example",
    domain_name="ws-api.example.com",
    domain_name_configuration=aws.apigatewayv2.DomainNameDomainNameConfigurationArgs(
        certificate_arn=aws_acm_certificate["example"]["arn"],
        endpoint_type="REGIONAL",
        security_policy="TLS_1_2",
    ))

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.apigatewayv2.DomainName("example", {
    domainName: "ws-api.example.com",
    domainNameConfiguration: {
        certificateArn: aws_acm_certificate.example.arn,
        endpointType: "REGIONAL",
        securityPolicy: "TLS_1_2",
    },
});

resources:
  example:
    type: aws:apigatewayv2:DomainName
    properties:
      domainName: ws-api.example.com
      domainNameConfiguration:
        certificateArn: ${aws_acm_certificate.example.arn}
        endpointType: REGIONAL
        securityPolicy: TLS_1_2

Associated Route 53 Resource Record

using System.Collections.Generic;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var exampleDomainName = new Aws.ApiGatewayV2.DomainName("exampleDomainName", new()
    {
        Domain = "http-api.example.com",
        DomainNameConfiguration = new Aws.ApiGatewayV2.Inputs.DomainNameDomainNameConfigurationArgs
        {
            CertificateArn = aws_acm_certificate.Example.Arn,
            EndpointType = "REGIONAL",
            SecurityPolicy = "TLS_1_2",
        },
    });

    var exampleRecord = new Aws.Route53.Record("exampleRecord", new()
    {
        Name = exampleDomainName.Domain,
        Type = "A",
        ZoneId = aws_route53_zone.Example.Zone_id,
        Aliases = new[]
        {
            new Aws.Route53.Inputs.RecordAliasArgs
            {
                Name = exampleDomainName.DomainNameConfiguration.Apply(domainNameConfiguration => domainNameConfiguration.TargetDomainName),
                ZoneId = exampleDomainName.DomainNameConfiguration.Apply(domainNameConfiguration => domainNameConfiguration.HostedZoneId),
                EvaluateTargetHealth = false,
            },
        },
    });

});

package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/apigatewayv2"
	"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/route53"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleDomainName, err := apigatewayv2.NewDomainName(ctx, "exampleDomainName", &apigatewayv2.DomainNameArgs{
			DomainName: pulumi.String("http-api.example.com"),
			DomainNameConfiguration: &apigatewayv2.DomainNameDomainNameConfigurationArgs{
				CertificateArn: pulumi.Any(aws_acm_certificate.Example.Arn),
				EndpointType:   pulumi.String("REGIONAL"),
				SecurityPolicy: pulumi.String("TLS_1_2"),
			},
		})
		if err != nil {
			return err
		}
		_, err = route53.NewRecord(ctx, "exampleRecord", &route53.RecordArgs{
			Name:   exampleDomainName.DomainName,
			Type:   pulumi.String("A"),
			ZoneId: pulumi.Any(aws_route53_zone.Example.Zone_id),
			Aliases: route53.RecordAliasArray{
				&route53.RecordAliasArgs{
					Name: exampleDomainName.DomainNameConfiguration.ApplyT(func(domainNameConfiguration apigatewayv2.DomainNameDomainNameConfiguration) (*string, error) {
						return &domainNameConfiguration.TargetDomainName, nil
					}).(pulumi.StringPtrOutput),
					ZoneId: exampleDomainName.DomainNameConfiguration.ApplyT(func(domainNameConfiguration apigatewayv2.DomainNameDomainNameConfiguration) (*string, error) {
						return &domainNameConfiguration.HostedZoneId, nil
					}).(pulumi.StringPtrOutput),
					EvaluateTargetHealth: pulumi.Bool(false),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.apigatewayv2.DomainName;
import com.pulumi.aws.apigatewayv2.DomainNameArgs;
import com.pulumi.aws.apigatewayv2.inputs.DomainNameDomainNameConfigurationArgs;
import com.pulumi.aws.route53.Record;
import com.pulumi.aws.route53.RecordArgs;
import com.pulumi.aws.route53.inputs.RecordAliasArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var exampleDomainName = new DomainName("exampleDomainName", DomainNameArgs.builder()        
            .domainName("http-api.example.com")
            .domainNameConfiguration(DomainNameDomainNameConfigurationArgs.builder()
                .certificateArn(aws_acm_certificate.example().arn())
                .endpointType("REGIONAL")
                .securityPolicy("TLS_1_2")
                .build())
            .build());

        var exampleRecord = new Record("exampleRecord", RecordArgs.builder()        
            .name(exampleDomainName.domainName())
            .type("A")
            .zoneId(aws_route53_zone.example().zone_id())
            .aliases(RecordAliasArgs.builder()
                .name(exampleDomainName.domainNameConfiguration().applyValue(domainNameConfiguration -> domainNameConfiguration.targetDomainName()))
                .zoneId(exampleDomainName.domainNameConfiguration().applyValue(domainNameConfiguration -> domainNameConfiguration.hostedZoneId()))
                .evaluateTargetHealth(false)
                .build())
            .build());

    }
}

import pulumi
import pulumi_aws as aws

example_domain_name = aws.apigatewayv2.DomainName("exampleDomainName",
    domain_name="http-api.example.com",
    domain_name_configuration=aws.apigatewayv2.DomainNameDomainNameConfigurationArgs(
        certificate_arn=aws_acm_certificate["example"]["arn"],
        endpoint_type="REGIONAL",
        security_policy="TLS_1_2",
    ))
example_record = aws.route53.Record("exampleRecord",
    name=example_domain_name.domain_name,
    type="A",
    zone_id=aws_route53_zone["example"]["zone_id"],
    aliases=[aws.route53.RecordAliasArgs(
        name=example_domain_name.domain_name_configuration.target_domain_name,
        zone_id=example_domain_name.domain_name_configuration.hosted_zone_id,
        evaluate_target_health=False,
    )])

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const exampleDomainName = new aws.apigatewayv2.DomainName("exampleDomainName", {
    domainName: "http-api.example.com",
    domainNameConfiguration: {
        certificateArn: aws_acm_certificate.example.arn,
        endpointType: "REGIONAL",
        securityPolicy: "TLS_1_2",
    },
});
const exampleRecord = new aws.route53.Record("exampleRecord", {
    name: exampleDomainName.domainName,
    type: "A",
    zoneId: aws_route53_zone.example.zone_id,
    aliases: [{
        name: exampleDomainName.domainNameConfiguration.apply(domainNameConfiguration => domainNameConfiguration.targetDomainName),
        zoneId: exampleDomainName.domainNameConfiguration.apply(domainNameConfiguration => domainNameConfiguration.hostedZoneId),
        evaluateTargetHealth: false,
    }],
});

resources:
  exampleDomainName:
    type: aws:apigatewayv2:DomainName
    properties:
      domainName: http-api.example.com
      domainNameConfiguration:
        certificateArn: ${aws_acm_certificate.example.arn}
        endpointType: REGIONAL
        securityPolicy: TLS_1_2
  exampleRecord:
    type: aws:route53:Record
    properties:
      name: ${exampleDomainName.domainName}
      type: A
      zoneId: ${aws_route53_zone.example.zone_id}
      aliases:
        - name: ${exampleDomainName.domainNameConfiguration.targetDomainName}
          zoneId: ${exampleDomainName.domainNameConfiguration.hostedZoneId}
          evaluateTargetHealth: false

Create DomainName Resource

new DomainName(name: string, args: DomainNameArgs, opts?: CustomResourceOptions);
@overload
def DomainName(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               domain_name: Optional[str] = None,
               domain_name_configuration: Optional[DomainNameDomainNameConfigurationArgs] = None,
               mutual_tls_authentication: Optional[DomainNameMutualTlsAuthenticationArgs] = None,
               tags: Optional[Mapping[str, str]] = None)
@overload
def DomainName(resource_name: str,
               args: DomainNameArgs,
               opts: Optional[ResourceOptions] = 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:apigatewayv2:DomainName
properties: # The arguments to resource properties.
options: # 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.
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:

Domain string

Domain name. Must be between 1 and 512 characters in length.

DomainNameConfiguration DomainNameDomainNameConfigurationArgs

Domain name configuration. See below.

MutualTlsAuthentication DomainNameMutualTlsAuthenticationArgs

Mutual TLS authentication configuration for the domain name.

Tags Dictionary<string, string>

Map of tags to assign to the domain name. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

DomainName string

Domain name. Must be between 1 and 512 characters in length.

DomainNameConfiguration DomainNameDomainNameConfigurationArgs

Domain name configuration. See below.

MutualTlsAuthentication DomainNameMutualTlsAuthenticationArgs

Mutual TLS authentication configuration for the domain name.

Tags map[string]string

Map of tags to assign to the domain name. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

domainName String

Domain name. Must be between 1 and 512 characters in length.

domainNameConfiguration DomainNameDomainNameConfigurationArgs

Domain name configuration. See below.

mutualTlsAuthentication DomainNameMutualTlsAuthenticationArgs

Mutual TLS authentication configuration for the domain name.

tags Map<String,String>

Map of tags to assign to the domain name. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

domainName string

Domain name. Must be between 1 and 512 characters in length.

domainNameConfiguration DomainNameDomainNameConfigurationArgs

Domain name configuration. See below.

mutualTlsAuthentication DomainNameMutualTlsAuthenticationArgs

Mutual TLS authentication configuration for the domain name.

tags {[key: string]: string}

Map of tags to assign to the domain name. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

domain_name str

Domain name. Must be between 1 and 512 characters in length.

domain_name_configuration DomainNameDomainNameConfigurationArgs

Domain name configuration. See below.

mutual_tls_authentication DomainNameMutualTlsAuthenticationArgs

Mutual TLS authentication configuration for the domain name.

tags Mapping[str, str]

Map of tags to assign to the domain name. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

domainName String

Domain name. Must be between 1 and 512 characters in length.

domainNameConfiguration Property Map

Domain name configuration. See below.

mutualTlsAuthentication Property Map

Mutual TLS authentication configuration for the domain name.

tags Map<String>

Map of tags to assign to the domain name. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

Outputs

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

ApiMappingSelectionExpression string

API mapping selection expression for the domain name.

Arn string

ARN of the domain name.

Id string

The provider-assigned unique ID for this managed resource.

TagsAll Dictionary<string, string>

Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

ApiMappingSelectionExpression string

API mapping selection expression for the domain name.

Arn string

ARN of the domain name.

Id string

The provider-assigned unique ID for this managed resource.

TagsAll map[string]string

Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

apiMappingSelectionExpression String

API mapping selection expression for the domain name.

arn String

ARN of the domain name.

id String

The provider-assigned unique ID for this managed resource.

tagsAll Map<String,String>

Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

apiMappingSelectionExpression string

API mapping selection expression for the domain name.

arn string

ARN of the domain name.

id string

The provider-assigned unique ID for this managed resource.

tagsAll {[key: string]: string}

Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

api_mapping_selection_expression str

API mapping selection expression for the domain name.

arn str

ARN of the domain name.

id str

The provider-assigned unique ID for this managed resource.

tags_all Mapping[str, str]

Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

apiMappingSelectionExpression String

API mapping selection expression for the domain name.

arn String

ARN of the domain name.

id String

The provider-assigned unique ID for this managed resource.

tagsAll Map<String>

Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Look up Existing DomainName Resource

Get an existing DomainName resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: DomainNameState, opts?: CustomResourceOptions): DomainName
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        api_mapping_selection_expression: Optional[str] = None,
        arn: Optional[str] = None,
        domain_name: Optional[str] = None,
        domain_name_configuration: Optional[DomainNameDomainNameConfigurationArgs] = None,
        mutual_tls_authentication: Optional[DomainNameMutualTlsAuthenticationArgs] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None) -> DomainName
func GetDomainName(ctx *Context, name string, id IDInput, state *DomainNameState, opts ...ResourceOption) (*DomainName, error)
public static DomainName Get(string name, Input<string> id, DomainNameState? state, CustomResourceOptions? opts = null)
public static DomainName get(String name, Output<String> id, DomainNameState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
ApiMappingSelectionExpression string

API mapping selection expression for the domain name.

Arn string

ARN of the domain name.

Domain string

Domain name. Must be between 1 and 512 characters in length.

DomainNameConfiguration DomainNameDomainNameConfigurationArgs

Domain name configuration. See below.

MutualTlsAuthentication DomainNameMutualTlsAuthenticationArgs

Mutual TLS authentication configuration for the domain name.

Tags Dictionary<string, string>

Map of tags to assign to the domain name. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

TagsAll Dictionary<string, string>

Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

ApiMappingSelectionExpression string

API mapping selection expression for the domain name.

Arn string

ARN of the domain name.

DomainName string

Domain name. Must be between 1 and 512 characters in length.

DomainNameConfiguration DomainNameDomainNameConfigurationArgs

Domain name configuration. See below.

MutualTlsAuthentication DomainNameMutualTlsAuthenticationArgs

Mutual TLS authentication configuration for the domain name.

Tags map[string]string

Map of tags to assign to the domain name. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

TagsAll map[string]string

Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

apiMappingSelectionExpression String

API mapping selection expression for the domain name.

arn String

ARN of the domain name.

domainName String

Domain name. Must be between 1 and 512 characters in length.

domainNameConfiguration DomainNameDomainNameConfigurationArgs

Domain name configuration. See below.

mutualTlsAuthentication DomainNameMutualTlsAuthenticationArgs

Mutual TLS authentication configuration for the domain name.

tags Map<String,String>

Map of tags to assign to the domain name. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

tagsAll Map<String,String>

Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

apiMappingSelectionExpression string

API mapping selection expression for the domain name.

arn string

ARN of the domain name.

domainName string

Domain name. Must be between 1 and 512 characters in length.

domainNameConfiguration DomainNameDomainNameConfigurationArgs

Domain name configuration. See below.

mutualTlsAuthentication DomainNameMutualTlsAuthenticationArgs

Mutual TLS authentication configuration for the domain name.

tags {[key: string]: string}

Map of tags to assign to the domain name. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

tagsAll {[key: string]: string}

Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

api_mapping_selection_expression str

API mapping selection expression for the domain name.

arn str

ARN of the domain name.

domain_name str

Domain name. Must be between 1 and 512 characters in length.

domain_name_configuration DomainNameDomainNameConfigurationArgs

Domain name configuration. See below.

mutual_tls_authentication DomainNameMutualTlsAuthenticationArgs

Mutual TLS authentication configuration for the domain name.

tags Mapping[str, str]

Map of tags to assign to the domain name. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

tags_all Mapping[str, str]

Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

apiMappingSelectionExpression String

API mapping selection expression for the domain name.

arn String

ARN of the domain name.

domainName String

Domain name. Must be between 1 and 512 characters in length.

domainNameConfiguration Property Map

Domain name configuration. See below.

mutualTlsAuthentication Property Map

Mutual TLS authentication configuration for the domain name.

tags Map<String>

Map of tags to assign to the domain name. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

tagsAll Map<String>

Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Supporting Types

DomainNameDomainNameConfiguration

CertificateArn string

ARN of an AWS-managed certificate that will be used by the endpoint for the domain name. AWS Certificate Manager is the only supported source. Use the aws.acm.Certificate resource to configure an ACM certificate.

EndpointType string

Endpoint type. Valid values: REGIONAL.

SecurityPolicy string

Transport Layer Security (TLS) version of the security policy for the domain name. Valid values: TLS_1_2.

HostedZoneId string

Amazon Route 53 Hosted Zone ID of the endpoint.

OwnershipVerificationCertificateArn string

ARN of the AWS-issued certificate used to validate custom domain ownership (when certificate_arn is issued via an ACM Private CA or mutual_tls_authentication is configured with an ACM-imported certificate.)

TargetDomainName string

Target domain name.

CertificateArn string

ARN of an AWS-managed certificate that will be used by the endpoint for the domain name. AWS Certificate Manager is the only supported source. Use the aws.acm.Certificate resource to configure an ACM certificate.

EndpointType string

Endpoint type. Valid values: REGIONAL.

SecurityPolicy string

Transport Layer Security (TLS) version of the security policy for the domain name. Valid values: TLS_1_2.

HostedZoneId string

Amazon Route 53 Hosted Zone ID of the endpoint.

OwnershipVerificationCertificateArn string

ARN of the AWS-issued certificate used to validate custom domain ownership (when certificate_arn is issued via an ACM Private CA or mutual_tls_authentication is configured with an ACM-imported certificate.)

TargetDomainName string

Target domain name.

certificateArn String

ARN of an AWS-managed certificate that will be used by the endpoint for the domain name. AWS Certificate Manager is the only supported source. Use the aws.acm.Certificate resource to configure an ACM certificate.

endpointType String

Endpoint type. Valid values: REGIONAL.

securityPolicy String

Transport Layer Security (TLS) version of the security policy for the domain name. Valid values: TLS_1_2.

hostedZoneId String

Amazon Route 53 Hosted Zone ID of the endpoint.

ownershipVerificationCertificateArn String

ARN of the AWS-issued certificate used to validate custom domain ownership (when certificate_arn is issued via an ACM Private CA or mutual_tls_authentication is configured with an ACM-imported certificate.)

targetDomainName String

Target domain name.

certificateArn string

ARN of an AWS-managed certificate that will be used by the endpoint for the domain name. AWS Certificate Manager is the only supported source. Use the aws.acm.Certificate resource to configure an ACM certificate.

endpointType string

Endpoint type. Valid values: REGIONAL.

securityPolicy string

Transport Layer Security (TLS) version of the security policy for the domain name. Valid values: TLS_1_2.

hostedZoneId string

Amazon Route 53 Hosted Zone ID of the endpoint.

ownershipVerificationCertificateArn string

ARN of the AWS-issued certificate used to validate custom domain ownership (when certificate_arn is issued via an ACM Private CA or mutual_tls_authentication is configured with an ACM-imported certificate.)

targetDomainName string

Target domain name.

certificate_arn str

ARN of an AWS-managed certificate that will be used by the endpoint for the domain name. AWS Certificate Manager is the only supported source. Use the aws.acm.Certificate resource to configure an ACM certificate.

endpoint_type str

Endpoint type. Valid values: REGIONAL.

security_policy str

Transport Layer Security (TLS) version of the security policy for the domain name. Valid values: TLS_1_2.

hosted_zone_id str

Amazon Route 53 Hosted Zone ID of the endpoint.

ownership_verification_certificate_arn str

ARN of the AWS-issued certificate used to validate custom domain ownership (when certificate_arn is issued via an ACM Private CA or mutual_tls_authentication is configured with an ACM-imported certificate.)

target_domain_name str

Target domain name.

certificateArn String

ARN of an AWS-managed certificate that will be used by the endpoint for the domain name. AWS Certificate Manager is the only supported source. Use the aws.acm.Certificate resource to configure an ACM certificate.

endpointType String

Endpoint type. Valid values: REGIONAL.

securityPolicy String

Transport Layer Security (TLS) version of the security policy for the domain name. Valid values: TLS_1_2.

hostedZoneId String

Amazon Route 53 Hosted Zone ID of the endpoint.

ownershipVerificationCertificateArn String

ARN of the AWS-issued certificate used to validate custom domain ownership (when certificate_arn is issued via an ACM Private CA or mutual_tls_authentication is configured with an ACM-imported certificate.)

targetDomainName String

Target domain name.

DomainNameMutualTlsAuthentication

TruststoreUri string

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.

TruststoreVersion string

Version of the S3 object that contains the truststore. To specify a version, you must have versioning enabled for the S3 bucket.

TruststoreUri string

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.

TruststoreVersion string

Version of the S3 object that contains the truststore. To specify a version, you must have versioning enabled for the S3 bucket.

truststoreUri String

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.

truststoreVersion String

Version of the S3 object that contains the truststore. To specify a version, you must have versioning enabled for the S3 bucket.

truststoreUri string

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.

truststoreVersion string

Version of the S3 object that contains the truststore. To specify a version, you must have versioning enabled for the S3 bucket.

truststore_uri str

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.

truststore_version str

Version of the S3 object that contains the truststore. To specify a version, you must have versioning enabled for the S3 bucket.

truststoreUri String

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.

truststoreVersion String

Version of the S3 object that contains the truststore. To specify a version, you must have versioning enabled for the S3 bucket.

Import

aws_apigatewayv2_domain_name can be imported by using the domain name, e.g.,

 $ pulumi import aws:apigatewayv2/domainName:DomainName example ws-api.example.com

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes

This Pulumi package is based on the aws Terraform Provider.