DomainNameState class

Input properties used for looking up and filtering DomainName resources.

Constructors

DomainNameState({Input<String?>? arn, Input<String?>? certificateArn, Input<String?>? certificateBody, Input<String?>? certificateChain, Input<String?>? certificateName, Input<String?>? certificatePrivateKey, Input<String?>? certificateUploadDate, Input<String?>? cloudfrontDomainName, Input<String?>? cloudfrontZoneId, Input<String?>? domainName, Input<String?>? domainNameId, Input<String?>? endpointAccessMode, Input<DomainNameEndpointConfiguration?>? endpointConfiguration, Input<DomainNameMutualTlsAuthentication?>? mutualTlsAuthentication, Input<String?>? ownershipVerificationCertificateArn, Input<String?>? policy, Input<String?>? region, Input<String?>? regionalCertificateArn, Input<String?>? regionalCertificateName, Input<String?>? regionalDomainName, Input<String?>? regionalZoneId, Input<String?>? routingMode, Input<String?>? securityPolicy, Input<Map<String, String>?>? tags, Input<Map<String, String>?>? tagsAll})
Creates a new DomainNameState. arn ARN of domain name. certificateArn 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 certificateName, certificateBody, certificateChain, certificatePrivateKey, regionalCertificateArn, and regionalCertificateName. certificateBody Certificate issued for the domain name being registered, in PEM format. Only valid for EDGE endpoint configuration type. Conflicts with certificateArn, regionalCertificateArn, and regionalCertificateName. certificateChain 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 certificateArn, regionalCertificateArn, and regionalCertificateName. certificateName Unique name to use when registering this certificate as an IAM server certificate. Conflicts with certificateArn, regionalCertificateArn, and regionalCertificateName. Required if certificateArn is not set. certificatePrivateKey Private key associated with the domain certificate given in certificateBody. Only valid for EDGE endpoint configuration type. Conflicts with certificateArn, regionalCertificateArn, and regionalCertificateName. certificateUploadDate Upload date associated with the domain certificate. cloudfrontDomainName Hostname created by Cloudfront to represent the distribution that implements this domain name mapping. cloudfrontZoneId For convenience, the hosted zone ID (Z2FDTNDATAQYW2) that can be used to create a Route53 alias record for the distribution. domainName Fully-qualified domain name to register. domainNameId Identifier for the domain name resource. Supported only for private custom domain names. endpointAccessMode Endpoint access mode of the DomainName. Only available for domain names that use security policies that start with SecurityPolicy_. Valid values: BASIC, STRICT. endpointConfiguration Configuration block defining API endpoint information including type. See below. mutualTlsAuthentication Mutual TLS authentication configuration for the domain name. See below. ownershipVerificationCertificateArn ARN of the AWS-issued certificate used to validate custom domain ownership (when certificateArn is issued via an ACM Private CA or mutualTlsAuthentication is configured with an ACM-imported certificate.) policy Stringified JSON policy document that applies to the execute-api service for this DomainName regardless of the caller and Method configuration. Supported only for private custom domain names. region Region where this resource will be managed. Defaults to the Region set in the provider configuration. regionalCertificateArn ARN for an AWS-managed certificate. AWS Certificate Manager is the only supported source. Used when a regional domain name is desired. Conflicts with certificateArn, certificateName, certificateBody, certificateChain, and certificatePrivateKey. regionalCertificateName User-friendly name of the certificate that will be used by regional endpoint for this domain name. Conflicts with certificateArn, certificateName, certificateBody, certificateChain, and certificatePrivateKey. regionalDomainName Hostname for the custom domain's regional endpoint. regionalZoneId Hosted zone ID that can be used to create a Route53 alias record for the regional endpoint. routingMode Mode to route traffic for the domain name. Valid values: BASE_PATH_MAPPING_ONLY, ROUTING_RULE_ONLY, ROUTING_RULE_THEN_BASE_PATH_MAPPING. securityPolicy TLS version + cipher suite for this DomainName. Must be configured to perform drift detection. For a list of valid security policies, see DomainName in the Amazon API Gateway API Reference. tags Key-value map of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level. tagsAll Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
const
DomainNameState.fromMap(Map<String, dynamic> map)
factory

Properties

arn → Input<String?>?
ARN of domain name.
final
certificateArn → Input<String?>?
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 certificateName, certificateBody, certificateChain, certificatePrivateKey, regionalCertificateArn, and regionalCertificateName.
final
certificateBody → Input<String?>?
Certificate issued for the domain name being registered, in PEM format. Only valid for EDGE endpoint configuration type. Conflicts with certificateArn, regionalCertificateArn, and regionalCertificateName.
final
certificateChain → Input<String?>?
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 certificateArn, regionalCertificateArn, and regionalCertificateName.
final
certificateName → Input<String?>?
Unique name to use when registering this certificate as an IAM server certificate. Conflicts with certificateArn, regionalCertificateArn, and regionalCertificateName. Required if certificateArn is not set.
final
certificatePrivateKey → Input<String?>?
Private key associated with the domain certificate given in certificateBody. Only valid for EDGE endpoint configuration type. Conflicts with certificateArn, regionalCertificateArn, and regionalCertificateName.
final
certificateUploadDate → Input<String?>?
Upload date associated with the domain certificate.
final
cloudfrontDomainName → Input<String?>?
Hostname created by Cloudfront to represent the distribution that implements this domain name mapping.
final
cloudfrontZoneId → Input<String?>?
For convenience, the hosted zone ID (Z2FDTNDATAQYW2) that can be used to create a Route53 alias record for the distribution.
final
domainName → Input<String?>?
Fully-qualified domain name to register.
final
domainNameId → Input<String?>?
Identifier for the domain name resource. Supported only for private custom domain names.
final
endpointAccessMode → Input<String?>?
Endpoint access mode of the DomainName. Only available for domain names that use security policies that start with SecurityPolicy_. Valid values: BASIC, STRICT.
final
endpointConfiguration → Input<DomainNameEndpointConfiguration?>?
Configuration block defining API endpoint information including type. See below.
final
hashCode → int
The hash code for this object.
no setterinherited
mutualTlsAuthentication → Input<DomainNameMutualTlsAuthentication?>?
Mutual TLS authentication configuration for the domain name. See below.
final
ownershipVerificationCertificateArn → Input<String?>?
ARN of the AWS-issued certificate used to validate custom domain ownership (when certificateArn is issued via an ACM Private CA or mutualTlsAuthentication is configured with an ACM-imported certificate.)
final
policy → Input<String?>?
Stringified JSON policy document that applies to the execute-api service for this DomainName regardless of the caller and Method configuration. Supported only for private custom domain names.
final
region → Input<String?>?
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
regionalCertificateArn → Input<String?>?
ARN for an AWS-managed certificate. AWS Certificate Manager is the only supported source. Used when a regional domain name is desired. Conflicts with certificateArn, certificateName, certificateBody, certificateChain, and certificatePrivateKey.
final
regionalCertificateName → Input<String?>?
User-friendly name of the certificate that will be used by regional endpoint for this domain name. Conflicts with certificateArn, certificateName, certificateBody, certificateChain, and certificatePrivateKey.
final
regionalDomainName → Input<String?>?
Hostname for the custom domain's regional endpoint.
final
regionalZoneId → Input<String?>?
Hosted zone ID that can be used to create a Route53 alias record for the regional endpoint.
final
routingMode → Input<String?>?
Mode to route traffic for the domain name. Valid values: BASE_PATH_MAPPING_ONLY, ROUTING_RULE_ONLY, ROUTING_RULE_THEN_BASE_PATH_MAPPING.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
securityPolicy → Input<String?>?
TLS version + cipher suite for this DomainName. Must be configured to perform drift detection. For a list of valid security policies, see DomainName in the Amazon API Gateway API Reference.
final
tags → Input<Map<String, String>?>?
Key-value map of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
final
tagsAll → Input<Map<String, String>?>?
Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited