Class 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 Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
public MyStack()
{
    var example = new Aws.ApiGatewayV2.DomainName("example", new Aws.ApiGatewayV2.DomainNameArgs
    {
        DomainName = "ws-api.example.com",
        DomainNameConfiguration = new Aws.ApiGatewayV2.Inputs.DomainNameDomainNameConfigurationArgs
        {
            CertificateArn = aws_acm_certificate.Example.Arn,
            EndpointType = "REGIONAL",
            SecurityPolicy = "TLS_1_2",
        },
    });
}

}

Inheritance

System.Object

Resource

CustomResource

DomainName

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Aws.ApiGatewayV2

Assembly: Pulumi.Aws.dll

Syntax

public class DomainName : CustomResource

Constructors

DomainName(String, DomainNameArgs, CustomResourceOptions)

Create a DomainName resource with the given unique name, arguments, and options.

Declaration

public DomainName(string name, DomainNameArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
DomainNameArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

ApiMappingSelectionExpression

The API mapping selection expression for the domain name.

Declaration

public Output<string> ApiMappingSelectionExpression { get; }

Property Value

Type	Description
Output<System.String>

Arn

The ARN of the domain name.

Declaration

public Output<string> Arn { get; }

Property Value

Type	Description
Output<System.String>

Domain

The domain name.

Declaration

public Output<string> Domain { get; }

Property Value

Type	Description
Output<System.String>

DomainNameConfiguration

The domain name configuration.

Declaration

public Output<DomainNameDomainNameConfiguration> DomainNameConfiguration { get; }

Property Value

Type	Description
Output<DomainNameDomainNameConfiguration>

Tags

A map of tags to assign to the domain name.

Declaration

public Output<ImmutableDictionary<string, object>> Tags { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.Object>>

Methods

Get(String, Input<String>, DomainNameState, CustomResourceOptions)

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

Declaration

public static DomainName Get(string name, Input<string> id, DomainNameState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
DomainNameState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
DomainName