Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. apigateway
  5. DomainNameV2

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

AWS Cloud Control v1.28.0 published on Monday, May 19, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.apigateway.DomainNameV2

Explore with Pulumi AI

aws-native logo

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

AWS Cloud Control v1.28.0 published on Monday, May 19, 2025 by Pulumi
pulumi/pulumi-aws-native

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

    Create DomainNameV2 Resource

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

    Constructor syntax

    new DomainNameV2(name: string, args?: DomainNameV2Args, opts?: CustomResourceOptions);
    @overload
def DomainNameV2(resource_name: str,
                 args: Optional[DomainNameV2Args] = None,
                 opts: Optional[ResourceOptions] = None)

@overload
def DomainNameV2(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 certificate_arn: Optional[str] = None,
                 domain_name: Optional[str] = None,
                 endpoint_configuration: Optional[DomainNameV2EndpointConfigurationArgs] = None,
                 policy: Optional[Any] = None,
                 routing_mode: Optional[DomainNameV2RoutingMode] = None,
                 security_policy: Optional[str] = None,
                 tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
    func NewDomainNameV2(ctx *Context, name string, args *DomainNameV2Args, opts ...ResourceOption) (*DomainNameV2, error)
    public DomainNameV2(string name, DomainNameV2Args? args = null, CustomResourceOptions? opts = null)
    public DomainNameV2(String name, DomainNameV2Args args)
public DomainNameV2(String name, DomainNameV2Args args, CustomResourceOptions options)

    type: aws-native:apigateway:DomainNameV2
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 DomainNameV2Args
    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 DomainNameV2Args
    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 DomainNameV2Args
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DomainNameV2Args
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DomainNameV2Args
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    DomainNameV2 Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The DomainNameV2 resource accepts the following input properties:

    CertificateArn string
    The reference to an AWS -managed certificate that will be used by the private endpoint for this domain name. AWS Certificate Manager is the only supported source.
    DomainName string
    Represents a custom domain name as a user-friendly host name of an API (RestApi).
    EndpointConfiguration Pulumi.AwsNative.ApiGateway.Inputs.DomainNameV2EndpointConfiguration
    The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has and the IP address types that can invoke it.
    Policy object

    A stringified JSON policy document that applies to the execute-api service for this DomainName regardless of the caller and Method configuration. You can use Fn::ToJsonString to enter your policy . For more information, see Fn::ToJsonString .

    Search the CloudFormation User Guide for AWS::ApiGateway::DomainNameV2 for more information about the expected schema for this property.

    RoutingMode Pulumi.AwsNative.ApiGateway.DomainNameV2RoutingMode
    The valid routing modes are [BASE_PATH_MAPPING_ONLY], [ROUTING_RULE_THEN_BASE_PATH_MAPPING] and [ROUTING_RULE_ONLY]. All other inputs are invalid.
    SecurityPolicy string
    The Transport Layer Security (TLS) version + cipher suite for this DomainName. Only TLS_1_2 is supported.
    Tags List<Pulumi.AwsNative.Inputs.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 the private endpoint for this domain name. AWS Certificate Manager is the only supported source.
    DomainName string
    Represents a custom domain name as a user-friendly host name of an API (RestApi).
    EndpointConfiguration DomainNameV2EndpointConfigurationArgs
    The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has and the IP address types that can invoke it.
    Policy interface{}

    A stringified JSON policy document that applies to the execute-api service for this DomainName regardless of the caller and Method configuration. You can use Fn::ToJsonString to enter your policy . For more information, see Fn::ToJsonString .

    Search the CloudFormation User Guide for AWS::ApiGateway::DomainNameV2 for more information about the expected schema for this property.

    RoutingMode DomainNameV2RoutingMode
    The valid routing modes are [BASE_PATH_MAPPING_ONLY], [ROUTING_RULE_THEN_BASE_PATH_MAPPING] and [ROUTING_RULE_ONLY]. All other inputs are invalid.
    SecurityPolicy string
    The Transport Layer Security (TLS) version + cipher suite for this DomainName. Only TLS_1_2 is supported.
    Tags TagArgs
    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 the private endpoint for this domain name. AWS Certificate Manager is the only supported source.
    domainName String
    Represents a custom domain name as a user-friendly host name of an API (RestApi).
    endpointConfiguration DomainNameV2EndpointConfiguration
    The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has and the IP address types that can invoke it.
    policy Object

    A stringified JSON policy document that applies to the execute-api service for this DomainName regardless of the caller and Method configuration. You can use Fn::ToJsonString to enter your policy . For more information, see Fn::ToJsonString .

    Search the CloudFormation User Guide for AWS::ApiGateway::DomainNameV2 for more information about the expected schema for this property.

    routingMode DomainNameV2RoutingMode
    The valid routing modes are [BASE_PATH_MAPPING_ONLY], [ROUTING_RULE_THEN_BASE_PATH_MAPPING] and [ROUTING_RULE_ONLY]. All other inputs are invalid.
    securityPolicy String
    The Transport Layer Security (TLS) version + cipher suite for this DomainName. Only TLS_1_2 is supported.
    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 the private endpoint for this domain name. AWS Certificate Manager is the only supported source.
    domainName string
    Represents a custom domain name as a user-friendly host name of an API (RestApi).
    endpointConfiguration DomainNameV2EndpointConfiguration
    The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has and the IP address types that can invoke it.
    policy any

    A stringified JSON policy document that applies to the execute-api service for this DomainName regardless of the caller and Method configuration. You can use Fn::ToJsonString to enter your policy . For more information, see Fn::ToJsonString .

    Search the CloudFormation User Guide for AWS::ApiGateway::DomainNameV2 for more information about the expected schema for this property.

    routingMode DomainNameV2RoutingMode
    The valid routing modes are [BASE_PATH_MAPPING_ONLY], [ROUTING_RULE_THEN_BASE_PATH_MAPPING] and [ROUTING_RULE_ONLY]. All other inputs are invalid.
    securityPolicy string
    The Transport Layer Security (TLS) version + cipher suite for this DomainName. Only TLS_1_2 is supported.
    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 the private endpoint for this domain name. AWS Certificate Manager is the only supported source.
    domain_name str
    Represents a custom domain name as a user-friendly host name of an API (RestApi).
    endpoint_configuration DomainNameV2EndpointConfigurationArgs
    The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has and the IP address types that can invoke it.
    policy Any

    A stringified JSON policy document that applies to the execute-api service for this DomainName regardless of the caller and Method configuration. You can use Fn::ToJsonString to enter your policy . For more information, see Fn::ToJsonString .

    Search the CloudFormation User Guide for AWS::ApiGateway::DomainNameV2 for more information about the expected schema for this property.

    routing_mode DomainNameV2RoutingMode
    The valid routing modes are [BASE_PATH_MAPPING_ONLY], [ROUTING_RULE_THEN_BASE_PATH_MAPPING] and [ROUTING_RULE_ONLY]. All other inputs are invalid.
    security_policy str
    The Transport Layer Security (TLS) version + cipher suite for this DomainName. Only TLS_1_2 is supported.
    tags Sequence[TagArgs]
    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 the private endpoint for this domain name. AWS Certificate Manager is the only supported source.
    domainName String
    Represents a custom domain name as a user-friendly host name of an API (RestApi).
    endpointConfiguration Property Map
    The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has and the IP address types that can invoke it.
    policy Any

    A stringified JSON policy document that applies to the execute-api service for this DomainName regardless of the caller and Method configuration. You can use Fn::ToJsonString to enter your policy . For more information, see Fn::ToJsonString .

    Search the CloudFormation User Guide for AWS::ApiGateway::DomainNameV2 for more information about the expected schema for this property.

    routingMode "BASE_PATH_MAPPING_ONLY" | "ROUTING_RULE_THEN_BASE_PATH_MAPPING" | "ROUTING_RULE_ONLY"
    The valid routing modes are [BASE_PATH_MAPPING_ONLY], [ROUTING_RULE_THEN_BASE_PATH_MAPPING] and [ROUTING_RULE_ONLY]. All other inputs are invalid.
    securityPolicy String
    The Transport Layer Security (TLS) version + cipher suite for this DomainName. Only TLS_1_2 is supported.
    tags List<Property Map>
    The collection of tags. Each tag element is associated with a given resource.

    Outputs

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

    DomainNameArn string
    The amazon resource name (ARN) of the domain name resource.
    DomainNameId string
    The domain name ID.
    Id string
    The provider-assigned unique ID for this managed resource.
    DomainNameArn string
    The amazon resource name (ARN) of the domain name resource.
    DomainNameId string
    The domain name ID.
    Id string
    The provider-assigned unique ID for this managed resource.
    domainNameArn String
    The amazon resource name (ARN) of the domain name resource.
    domainNameId String
    The domain name ID.
    id String
    The provider-assigned unique ID for this managed resource.
    domainNameArn string
    The amazon resource name (ARN) of the domain name resource.
    domainNameId string
    The domain name ID.
    id string
    The provider-assigned unique ID for this managed resource.
    domain_name_arn str
    The amazon resource name (ARN) of the domain name resource.
    domain_name_id str
    The domain name ID.
    id str
    The provider-assigned unique ID for this managed resource.
    domainNameArn String
    The amazon resource name (ARN) of the domain name resource.
    domainNameId String
    The domain name ID.
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    DomainNameV2EndpointConfiguration, DomainNameV2EndpointConfigurationArgs

    IpAddressType string
    The IP address types that can invoke an API (RestApi) or a DomainName. Use ipv4 to allow only IPv4 addresses to invoke an API or DomainName, or use dualstack to allow both IPv4 and IPv6 addresses to invoke an API or a DomainName. For the PRIVATE endpoint type, only dualstack is supported.
    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 .
    IpAddressType string
    The IP address types that can invoke an API (RestApi) or a DomainName. Use ipv4 to allow only IPv4 addresses to invoke an API or DomainName, or use dualstack to allow both IPv4 and IPv6 addresses to invoke an API or a DomainName. For the PRIVATE endpoint type, only dualstack is supported.
    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 .
    ipAddressType String
    The IP address types that can invoke an API (RestApi) or a DomainName. Use ipv4 to allow only IPv4 addresses to invoke an API or DomainName, or use dualstack to allow both IPv4 and IPv6 addresses to invoke an API or a DomainName. For the PRIVATE endpoint type, only dualstack is supported.
    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 .
    ipAddressType string
    The IP address types that can invoke an API (RestApi) or a DomainName. Use ipv4 to allow only IPv4 addresses to invoke an API or DomainName, or use dualstack to allow both IPv4 and IPv6 addresses to invoke an API or a DomainName. For the PRIVATE endpoint type, only dualstack is supported.
    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 .
    ip_address_type str
    The IP address types that can invoke an API (RestApi) or a DomainName. Use ipv4 to allow only IPv4 addresses to invoke an API or DomainName, or use dualstack to allow both IPv4 and IPv6 addresses to invoke an API or a DomainName. For the PRIVATE endpoint type, only dualstack is supported.
    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 .
    ipAddressType String
    The IP address types that can invoke an API (RestApi) or a DomainName. Use ipv4 to allow only IPv4 addresses to invoke an API or DomainName, or use dualstack to allow both IPv4 and IPv6 addresses to invoke an API or a DomainName. For the PRIVATE endpoint type, only dualstack is supported.
    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 .

    DomainNameV2RoutingMode, DomainNameV2RoutingModeArgs

    BasePathMappingOnly
    BASE_PATH_MAPPING_ONLY
    RoutingRuleThenBasePathMapping
    ROUTING_RULE_THEN_BASE_PATH_MAPPING
    RoutingRuleOnly
    ROUTING_RULE_ONLY
    DomainNameV2RoutingModeBasePathMappingOnly
    BASE_PATH_MAPPING_ONLY
    DomainNameV2RoutingModeRoutingRuleThenBasePathMapping
    ROUTING_RULE_THEN_BASE_PATH_MAPPING
    DomainNameV2RoutingModeRoutingRuleOnly
    ROUTING_RULE_ONLY
    BasePathMappingOnly
    BASE_PATH_MAPPING_ONLY
    RoutingRuleThenBasePathMapping
    ROUTING_RULE_THEN_BASE_PATH_MAPPING
    RoutingRuleOnly
    ROUTING_RULE_ONLY
    BasePathMappingOnly
    BASE_PATH_MAPPING_ONLY
    RoutingRuleThenBasePathMapping
    ROUTING_RULE_THEN_BASE_PATH_MAPPING
    RoutingRuleOnly
    ROUTING_RULE_ONLY
    BASE_PATH_MAPPING_ONLY
    BASE_PATH_MAPPING_ONLY
    ROUTING_RULE_THEN_BASE_PATH_MAPPING
    ROUTING_RULE_THEN_BASE_PATH_MAPPING
    ROUTING_RULE_ONLY
    ROUTING_RULE_ONLY
    "BASE_PATH_MAPPING_ONLY"
    BASE_PATH_MAPPING_ONLY
    "ROUTING_RULE_THEN_BASE_PATH_MAPPING"
    ROUTING_RULE_THEN_BASE_PATH_MAPPING
    "ROUTING_RULE_ONLY"
    ROUTING_RULE_ONLY

    Tag, TagArgs

    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

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

    AWS Cloud Control v1.28.0 published on Monday, May 19, 2025 by Pulumi
    pulumi/pulumi-aws-native