Package com.pulumi.aws.apigateway.inputs

Class DomainNameState

  • public final class DomainNameState
extends com.pulumi.resources.ResourceArgs

    • Method Detail

      • arn

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> arn()
        Returns:
        ARN of domain name.

      • certificateArn

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> certificateArn()
        Returns:
        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

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> certificateBody()
        Returns:
        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

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> certificateChain()
        Returns:
        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

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> certificateName()
        Returns:
        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

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> certificatePrivateKey()
        Returns:
        Private key associated with the domain certificate given in `certificateBody`. Only valid for `EDGE` endpoint configuration type. Conflicts with `certificateArn`, `regionalCertificateArn`, and `regionalCertificateName`.

      • certificateUploadDate

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> certificateUploadDate()
        Returns:
        Upload date associated with the domain certificate.

      • cloudfrontDomainName

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> cloudfrontDomainName()
        Returns:
        Hostname created by CloudFront to represent the distribution that implements this domain name mapping.

      • cloudfrontZoneId

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> cloudfrontZoneId()
        Returns:
        For convenience, the hosted zone ID (`Z2FDTNDATAQYW2`) that can be used to create a Route53 alias record for the distribution.

      • domainName

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> domainName()
        Returns:
        Fully-qualified domain name to register.

      • domainNameId

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> domainNameId()
        Returns:
        Identifier for the domain name resource. Supported only for private custom domain names.

      • endpointAccessMode

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> endpointAccessMode()
        Returns:
        Endpoint access mode of the DomainName. Only available for domain names that use security policies that start with `SecurityPolicy_`. Valid values: `BASIC`, `STRICT`.

      • endpointConfiguration

        public java.util.Optional<com.pulumi.core.Output<DomainNameEndpointConfigurationArgs>> endpointConfiguration()
        Returns:
        Configuration block defining API endpoint information including type. See below.

      • mutualTlsAuthentication

        public java.util.Optional<com.pulumi.core.Output<DomainNameMutualTlsAuthenticationArgs>> mutualTlsAuthentication()
        Returns:
        Mutual TLS authentication configuration for the domain name. See below.

      • ownershipVerificationCertificateArn

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> ownershipVerificationCertificateArn()
        Returns:
        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

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> policy()
        Returns:
        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

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • regionalCertificateArn

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> regionalCertificateArn()
        Returns:
        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

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> regionalCertificateName()
        Returns:
        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

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> regionalDomainName()
        Returns:
        Hostname for the custom domain's regional endpoint.

      • regionalZoneId

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> regionalZoneId()
        Returns:
        Hosted zone ID that can be used to create a Route53 alias record for the regional endpoint.

      • routingMode

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> routingMode()
        Returns:
        Mode to route traffic for the domain name. Valid values: `BASE_PATH_MAPPING_ONLY`, `ROUTING_RULE_ONLY`, `ROUTING_RULE_THEN_BASE_PATH_MAPPING`.

      • securityPolicy

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> securityPolicy()
        Returns:
        TLS version + cipher suite for this DomainName. Must be configured to perform drift detection. For a list of valid security policies, see [DomainName](https://docs.aws.amazon.com/apigateway/latest/api/API_DomainName.html) in the Amazon API Gateway API Reference.

      • tags

        public java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        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

        public java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> tagsAll()
        Returns:
        Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.