Class DomainNameState
Inherited Members
Namespace: Pulumi.Aws.ApiGateway
Assembly: Pulumi.Aws.dll
Syntax
public sealed class DomainNameState : ResourceArgs
Constructors
View SourceDomainNameState()
Declaration
public DomainNameState()
Properties
View SourceArn
Amazon Resource Name (ARN)
Declaration
public Input<string> Arn { get; set; }
Property Value
| Type | Description |
|---|---|
| Input<System.String> |
CertificateArn
The ARN for an AWS-managed certificate. AWS Certificate Manager is the only supported source. Used when an edge-optimized domain name is desired. Conflicts with certificate_name, certificate_body, certificate_chain, certificate_private_key, regional_certificate_arn, and regional_certificate_name.
Declaration
public Input<string> CertificateArn { get; set; }
Property Value
| Type | Description |
|---|---|
| Input<System.String> |
CertificateBody
The certificate issued for the domain name
being registered, in PEM format. Only valid for EDGE endpoint configuration type. Conflicts with certificate_arn, regional_certificate_arn, and
regional_certificate_name.
Declaration
public Input<string> CertificateBody { get; set; }
Property Value
| Type | Description |
|---|---|
| Input<System.String> |
CertificateChain
The certificate for the CA that issued the
certificate, along with any intermediate CA certificates required to
create an unbroken chain to a certificate trusted by the intended API clients. Only valid for EDGE endpoint configuration type. Conflicts with certificate_arn,
regional_certificate_arn, and regional_certificate_name.
Declaration
public Input<string> CertificateChain { get; set; }
Property Value
| Type | Description |
|---|---|
| Input<System.String> |
CertificateName
The unique name to use when registering this
certificate as an IAM server certificate. Conflicts with certificate_arn, regional_certificate_arn, and
regional_certificate_name. Required if certificate_arn is not set.
Declaration
public Input<string> CertificateName { get; set; }
Property Value
| Type | Description |
|---|---|
| Input<System.String> |
CertificatePrivateKey
The private key associated with the
domain certificate given in certificate_body. Only valid for EDGE endpoint configuration type. Conflicts with certificate_arn, regional_certificate_arn, and regional_certificate_name.
Declaration
public Input<string> CertificatePrivateKey { get; set; }
Property Value
| Type | Description |
|---|---|
| Input<System.String> |
CertificateUploadDate
The upload date associated with the domain certificate.
Declaration
public Input<string> CertificateUploadDate { get; set; }
Property Value
| Type | Description |
|---|---|
| Input<System.String> |
CloudfrontDomainName
The hostname created by Cloudfront to represent the distribution that implements this domain name mapping.
Declaration
public Input<string> CloudfrontDomainName { get; set; }
Property Value
| Type | Description |
|---|---|
| Input<System.String> |
CloudfrontZoneId
For convenience, the hosted zone ID (Z2FDTNDATAQYW2)
that can be used to create a Route53 alias record for the distribution.
Declaration
public Input<string> CloudfrontZoneId { get; set; }
Property Value
| Type | Description |
|---|---|
| Input<System.String> |
Domain
The fully-qualified domain name to register
Declaration
public Input<string> Domain { get; set; }
Property Value
| Type | Description |
|---|---|
| Input<System.String> |
EndpointConfiguration
Configuration block defining API endpoint information including type. Defined below.
Declaration
public Input<DomainNameEndpointConfigurationGetArgs> EndpointConfiguration { get; set; }
Property Value
| Type | Description |
|---|---|
| Input<DomainNameEndpointConfigurationGetArgs> |
RegionalCertificateArn
The ARN for an AWS-managed certificate. AWS Certificate Manager is the only supported source. Used when a regional domain name is desired. Conflicts with certificate_arn, certificate_name, certificate_body, certificate_chain, and certificate_private_key.
Declaration
public Input<string> RegionalCertificateArn { get; set; }
Property Value
| Type | Description |
|---|---|
| Input<System.String> |
RegionalCertificateName
The user-friendly name of the certificate that will be used by regional endpoint for this domain name. Conflicts with certificate_arn, certificate_name, certificate_body, certificate_chain, and
certificate_private_key.
Declaration
public Input<string> RegionalCertificateName { get; set; }
Property Value
| Type | Description |
|---|---|
| Input<System.String> |
RegionalDomainName
The hostname for the custom domain's regional endpoint.
Declaration
public Input<string> RegionalDomainName { get; set; }
Property Value
| Type | Description |
|---|---|
| Input<System.String> |
RegionalZoneId
The hosted zone ID that can be used to create a Route53 alias record for the regional endpoint.
Declaration
public Input<string> RegionalZoneId { get; set; }
Property Value
| Type | Description |
|---|---|
| Input<System.String> |
SecurityPolicy
The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are TLS_1_0 and TLS_1_2. Must be configured to perform drift detection.
Declaration
public Input<string> SecurityPolicy { get; set; }
Property Value
| Type | Description |
|---|---|
| Input<System.String> |
Tags
Key-value map of resource tags
Declaration
public InputMap<object> Tags { get; set; }
Property Value
| Type | Description |
|---|---|
| InputMap<System.Object> |