DomainNameArgs class
The set of arguments for DomainName. The set of arguments for DomainName.
Constructors
-
DomainNameArgs({Input<
String?> ? certificateArn, Input<String?> ? certificateBody, Input<String?> ? certificateChain, Input<String?> ? certificateName, Input<String?> ? certificatePrivateKey, required Input<String> domainName, 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?> ? routingMode, Input<String?> ? securityPolicy, Input<Map< ? tags})String, String> ?> -
Creates a new DomainNameArgs.
certificateArnARN for an AWS-managed certificate. AWS Certificate Manager is the only supported source. Used when an edge-optimized domain name is desired. Conflicts withcertificateName,certificateBody,certificateChain,certificatePrivateKey,regionalCertificateArn, andregionalCertificateName.certificateBodyCertificate issued for the domain name being registered, in PEM format. Only valid forEDGEendpoint configuration type. Conflicts withcertificateArn,regionalCertificateArn, andregionalCertificateName.certificateChainCertificate 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 forEDGEendpoint configuration type. Conflicts withcertificateArn,regionalCertificateArn, andregionalCertificateName.certificateNameUnique name to use when registering this certificate as an IAM server certificate. Conflicts withcertificateArn,regionalCertificateArn, andregionalCertificateName. Required ifcertificateArnis not set.certificatePrivateKeyPrivate key associated with the domain certificate given incertificateBody. Only valid forEDGEendpoint configuration type. Conflicts withcertificateArn,regionalCertificateArn, andregionalCertificateName.domainNameFully-qualified domain name to register.endpointAccessModeEndpoint access mode of the DomainName. Only available for domain names that use security policies that start withSecurityPolicy_. Valid values:BASIC,STRICT.endpointConfigurationConfiguration block defining API endpoint information including type. See below.mutualTlsAuthenticationMutual TLS authentication configuration for the domain name. See below.ownershipVerificationCertificateArnARN of the AWS-issued certificate used to validate custom domain ownership (whencertificateArnis issued via an ACM Private CA ormutualTlsAuthenticationis configured with an ACM-imported certificate.)policyStringified 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.regionRegion where this resource will be managed. Defaults to the Region set in the provider configuration.regionalCertificateArnARN for an AWS-managed certificate. AWS Certificate Manager is the only supported source. Used when a regional domain name is desired. Conflicts withcertificateArn,certificateName,certificateBody,certificateChain, andcertificatePrivateKey.regionalCertificateNameUser-friendly name of the certificate that will be used by regional endpoint for this domain name. Conflicts withcertificateArn,certificateName,certificateBody,certificateChain, andcertificatePrivateKey.routingModeMode to route traffic for the domain name. Valid values:BASE_PATH_MAPPING_ONLY,ROUTING_RULE_ONLY,ROUTING_RULE_THEN_BASE_PATH_MAPPING.securityPolicyTLS 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.tagsKey-value map of resource tags. If configured with a providerdefaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.const -
DomainNameArgs.fromMap(Map<
String, dynamic> map) -
factory
Properties
-
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, andregionalCertificateName.final -
certificateBody
→ Input<
String?> ? -
Certificate issued for the domain name being registered, in PEM format. Only valid for
EDGEendpoint configuration type. Conflicts withcertificateArn,regionalCertificateArn, andregionalCertificateName.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
EDGEendpoint configuration type. Conflicts withcertificateArn,regionalCertificateArn, andregionalCertificateName.final -
certificateName
→ Input<
String?> ? -
Unique name to use when registering this certificate as an IAM server certificate. Conflicts with
certificateArn,regionalCertificateArn, andregionalCertificateName. Required ifcertificateArnis not set.final -
certificatePrivateKey
→ Input<
String?> ? -
Private key associated with the domain certificate given in
certificateBody. Only valid forEDGEendpoint configuration type. Conflicts withcertificateArn,regionalCertificateArn, andregionalCertificateName.final -
domainName
→ Input<
String> -
Fully-qualified domain name to register.
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
certificateArnis issued via an ACM Private CA ormutualTlsAuthenticationis 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, andcertificatePrivateKey.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, andcertificatePrivateKey.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
-
Key-value map of resource tags. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.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