AWS Native

v0.29.0 published on Thursday, Sep 8, 2022 by Pulumi

DomainName

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

Example Usage

Example

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

return await Deployment.RunAsync(() => 
{
    var config = new Config();
    var cfnDomainName = config.Require("cfnDomainName");
    var certificateArn = config.Require("certificateArn");
    var type = config.Require("type");
    var myDomainName = new AwsNative.ApiGateway.DomainName("myDomainName", new()
    {
        CertificateArn = certificateArn,
        DomainNameValue = cfnDomainName,
        EndpointConfiguration = new AwsNative.ApiGateway.Inputs.DomainNameEndpointConfigurationArgs
        {
            Types = new[]
            {
                type,
            },
        },
        RegionalCertificateArn = certificateArn,
    });

    return new Dictionary<string, object?>
    {
        ["domainName"] = myDomainName.Id,
    };
});

Coming soon!

Coming soon!

import pulumi
import pulumi_aws_native as aws_native

config = pulumi.Config()
cfn_domain_name = config.require("cfnDomainName")
certificate_arn = config.require("certificateArn")
type = config.require("type")
my_domain_name = aws_native.apigateway.DomainName("myDomainName",
    certificate_arn=certificate_arn,
    domain_name=cfn_domain_name,
    endpoint_configuration=aws_native.apigateway.DomainNameEndpointConfigurationArgs(
        types=[type],
    ),
    regional_certificate_arn=certificate_arn)
pulumi.export("domainName", my_domain_name.id)
import * as pulumi from "@pulumi/pulumi";
import * as aws_native from "@pulumi/aws-native";

const config = new pulumi.Config();
const cfnDomainName = config.require("cfnDomainName");
const certificateArn = config.require("certificateArn");
const type = config.require("type");
const myDomainName = new aws_native.apigateway.DomainName("myDomainName", {
    certificateArn: certificateArn,
    domainName: cfnDomainName,
    endpointConfiguration: {
        types: [type],
    },
    regionalCertificateArn: certificateArn,
});
export const domainName = myDomainName.id;

Coming soon!

Example

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

return await Deployment.RunAsync(() => 
{
    var config = new Config();
    var cfnDomainName = config.Require("cfnDomainName");
    var certificateArn = config.Require("certificateArn");
    var type = config.Require("type");
    var myDomainName = new AwsNative.ApiGateway.DomainName("myDomainName", new()
    {
        CertificateArn = certificateArn,
        DomainNameValue = cfnDomainName,
        EndpointConfiguration = new AwsNative.ApiGateway.Inputs.DomainNameEndpointConfigurationArgs
        {
            Types = new[]
            {
                type,
            },
        },
        RegionalCertificateArn = certificateArn,
    });

    return new Dictionary<string, object?>
    {
        ["domainName"] = myDomainName.Id,
    };
});

Coming soon!

Coming soon!

import pulumi
import pulumi_aws_native as aws_native

config = pulumi.Config()
cfn_domain_name = config.require("cfnDomainName")
certificate_arn = config.require("certificateArn")
type = config.require("type")
my_domain_name = aws_native.apigateway.DomainName("myDomainName",
    certificate_arn=certificate_arn,
    domain_name=cfn_domain_name,
    endpoint_configuration=aws_native.apigateway.DomainNameEndpointConfigurationArgs(
        types=[type],
    ),
    regional_certificate_arn=certificate_arn)
pulumi.export("domainName", my_domain_name.id)
import * as pulumi from "@pulumi/pulumi";
import * as aws_native from "@pulumi/aws-native";

const config = new pulumi.Config();
const cfnDomainName = config.require("cfnDomainName");
const certificateArn = config.require("certificateArn");
const type = config.require("type");
const myDomainName = new aws_native.apigateway.DomainName("myDomainName", {
    certificateArn: certificateArn,
    domainName: cfnDomainName,
    endpointConfiguration: {
        types: [type],
    },
    regionalCertificateArn: certificateArn,
});
export const domainName = myDomainName.id;

Coming soon!

Create a DomainName Resource

new DomainName(name: string, args?: DomainNameArgs, opts?: CustomResourceOptions);
@overload
def DomainName(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               certificate_arn: Optional[str] = None,
               domain_name: Optional[str] = None,
               endpoint_configuration: Optional[DomainNameEndpointConfigurationArgs] = None,
               mutual_tls_authentication: Optional[DomainNameMutualTlsAuthenticationArgs] = None,
               ownership_verification_certificate_arn: Optional[str] = None,
               regional_certificate_arn: Optional[str] = None,
               security_policy: Optional[str] = None,
               tags: Optional[Sequence[DomainNameTagArgs]] = None)
@overload
def DomainName(resource_name: str,
               args: Optional[DomainNameArgs] = None,
               opts: Optional[ResourceOptions] = None)
func NewDomainName(ctx *Context, name string, args *DomainNameArgs, opts ...ResourceOption) (*DomainName, error)
public DomainName(string name, DomainNameArgs? args = null, CustomResourceOptions? opts = null)
public DomainName(String name, DomainNameArgs args)
public DomainName(String name, DomainNameArgs args, CustomResourceOptions options)
type: aws-native:apigateway: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:

Outputs

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

DistributionDomainName string
DistributionHostedZoneId string
Id string

The provider-assigned unique ID for this managed resource.

RegionalDomainName string
RegionalHostedZoneId string
DistributionDomainName string
DistributionHostedZoneId string
Id string

The provider-assigned unique ID for this managed resource.

RegionalDomainName string
RegionalHostedZoneId string
distributionDomainName String
distributionHostedZoneId String
id String

The provider-assigned unique ID for this managed resource.

regionalDomainName String
regionalHostedZoneId String
distributionDomainName string
distributionHostedZoneId string
id string

The provider-assigned unique ID for this managed resource.

regionalDomainName string
regionalHostedZoneId string
distribution_domain_name str
distribution_hosted_zone_id str
id str

The provider-assigned unique ID for this managed resource.

regional_domain_name str
regional_hosted_zone_id str
distributionDomainName String
distributionHostedZoneId String
id String

The provider-assigned unique ID for this managed resource.

regionalDomainName String
regionalHostedZoneId String

Supporting Types

DomainNameEndpointConfiguration

Types List<string>
Types []string
types List<String>
types string[]
types Sequence[str]
types List<String>

DomainNameMutualTlsAuthentication

DomainNameTag

Key string
Value string
Key string
Value string
key String
value String
key string
value string
key str
value str
key String
value String

Package Details

Repository
https://github.com/pulumi/pulumi-aws-native
License
Apache-2.0