Package software.amazon.awssdk.services.apigateway.model

Interface CreateDomainNameResponse.Builder

    • Method Detail

      • domainName

        CreateDomainNameResponse.Builder domainName​(String domainName)

        The custom domain name as an API host name, for example, my-api.example.com.

        Parameters:
        domainName - The custom domain name as an API host name, for example, my-api.example.com.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • domainNameId

        CreateDomainNameResponse.Builder domainNameId​(String domainNameId)

        The identifier for the domain name resource. Supported only for private custom domain names.

        Parameters:
        domainNameId - The identifier for the domain name resource. Supported only for private custom domain names.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • domainNameArn

        CreateDomainNameResponse.Builder domainNameArn​(String domainNameArn)

        The ARN of the domain name. Supported only for private custom domain names.

        Parameters:
        domainNameArn - The ARN of the domain name. Supported only for private custom domain names.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • certificateName

        CreateDomainNameResponse.Builder certificateName​(String certificateName)

        The name of the certificate that will be used by edge-optimized endpoint or private endpoint for this domain name.

        Parameters:
        certificateName - The name of the certificate that will be used by edge-optimized endpoint or private endpoint for this domain name.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • certificateArn

        CreateDomainNameResponse.Builder certificateArn​(String certificateArn)

        The reference to an Amazon Web Services-managed certificate that will be used by edge-optimized endpoint or private endpoint for this domain name. Certificate Manager is the only supported source.

        Parameters:
        certificateArn - The reference to an Amazon Web Services-managed certificate that will be used by edge-optimized endpoint or private endpoint for this domain name. Certificate Manager is the only supported source.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • certificateUploadDate

        CreateDomainNameResponse.Builder certificateUploadDate​(Instant certificateUploadDate)

        The timestamp when the certificate that was used by edge-optimized endpoint or private endpoint for this domain name was uploaded.

        Parameters:
        certificateUploadDate - The timestamp when the certificate that was used by edge-optimized endpoint or private endpoint for this domain name was uploaded.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • regionalDomainName

        CreateDomainNameResponse.Builder regionalDomainName​(String regionalDomainName)

        The domain name associated with the regional endpoint for this custom domain name. You set up this association by adding a DNS record that points the custom domain name to this regional domain name. The regional domain name is returned by API Gateway when you create a regional endpoint.

        Parameters:
        regionalDomainName - The domain name associated with the regional endpoint for this custom domain name. You set up this association by adding a DNS record that points the custom domain name to this regional domain name. The regional domain name is returned by API Gateway when you create a regional endpoint.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • regionalHostedZoneId

        CreateDomainNameResponse.Builder regionalHostedZoneId​(String regionalHostedZoneId)

        The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.

        Parameters:
        regionalHostedZoneId - The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • regionalCertificateName

        CreateDomainNameResponse.Builder regionalCertificateName​(String regionalCertificateName)

        The name of the certificate that will be used for validating the regional domain name.

        Parameters:
        regionalCertificateName - The name of the certificate that will be used for validating the regional domain name.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • regionalCertificateArn

        CreateDomainNameResponse.Builder regionalCertificateArn​(String regionalCertificateArn)

        The reference to an Amazon Web Services-managed certificate that will be used for validating the regional domain name. Certificate Manager is the only supported source.

        Parameters:
        regionalCertificateArn - The reference to an Amazon Web Services-managed certificate that will be used for validating the regional domain name. Certificate Manager is the only supported source.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • distributionDomainName

        CreateDomainNameResponse.Builder distributionDomainName​(String distributionDomainName)

        The domain name of the Amazon CloudFront distribution associated with this custom domain name for an edge-optimized endpoint. You set up this association when adding a DNS record pointing the custom domain name to this distribution name. For more information about CloudFront distributions, see the Amazon CloudFront documentation.

        Parameters:
        distributionDomainName - The domain name of the Amazon CloudFront distribution associated with this custom domain name for an edge-optimized endpoint. You set up this association when adding a DNS record pointing the custom domain name to this distribution name. For more information about CloudFront distributions, see the Amazon CloudFront documentation.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • distributionHostedZoneId

        CreateDomainNameResponse.Builder distributionHostedZoneId​(String distributionHostedZoneId)

        The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint. The valid value is Z2FDTNDATAQYW2 for all the regions. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.

        Parameters:
        distributionHostedZoneId - The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint. The valid value is Z2FDTNDATAQYW2 for all the regions. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • endpointConfiguration

        CreateDomainNameResponse.Builder endpointConfiguration​(EndpointConfiguration endpointConfiguration)

        The endpoint configuration of this DomainName showing the endpoint types of the domain name.

        Parameters:
        endpointConfiguration - The endpoint configuration of this DomainName showing the endpoint types of the domain name.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • domainNameStatus

        CreateDomainNameResponse.Builder domainNameStatus​(String domainNameStatus)

        The status of the DomainName migration. The valid values are AVAILABLE and UPDATING . If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated.

        Parameters:
        domainNameStatus - The status of the DomainName migration. The valid values are AVAILABLE and UPDATING. If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        DomainNameStatus, DomainNameStatus

      • domainNameStatus

        CreateDomainNameResponse.Builder domainNameStatus​(DomainNameStatus domainNameStatus)

        The status of the DomainName migration. The valid values are AVAILABLE and UPDATING . If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated.

        Parameters:
        domainNameStatus - The status of the DomainName migration. The valid values are AVAILABLE and UPDATING. If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        DomainNameStatus, DomainNameStatus

      • domainNameStatusMessage

        CreateDomainNameResponse.Builder domainNameStatusMessage​(String domainNameStatusMessage)

        An optional text message containing detailed information about status of the DomainName migration.

        Parameters:
        domainNameStatusMessage - An optional text message containing detailed information about status of the DomainName migration.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • securityPolicy

        CreateDomainNameResponse.Builder securityPolicy​(String securityPolicy)

        The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are TLS_1_0 and TLS_1_2.

        Parameters:
        securityPolicy - The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are TLS_1_0 and TLS_1_2.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        SecurityPolicy, SecurityPolicy

      • securityPolicy

        CreateDomainNameResponse.Builder securityPolicy​(SecurityPolicy securityPolicy)

        The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are TLS_1_0 and TLS_1_2.

        Parameters:
        securityPolicy - The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are TLS_1_0 and TLS_1_2.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        SecurityPolicy, SecurityPolicy

      • tags

        CreateDomainNameResponse.Builder tags​(Map<String,​String> tags)

        The collection of tags. Each tag element is associated with a given resource.

        Parameters:
        tags - The collection of tags. Each tag element is associated with a given resource.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • mutualTlsAuthentication

        CreateDomainNameResponse.Builder mutualTlsAuthentication​(MutualTlsAuthentication mutualTlsAuthentication)

        The mutual TLS authentication configuration for a custom domain name. If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.

        Parameters:
        mutualTlsAuthentication - The mutual TLS authentication configuration for a custom domain name. If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • ownershipVerificationCertificateArn

        CreateDomainNameResponse.Builder ownershipVerificationCertificateArn​(String ownershipVerificationCertificateArn)

        The ARN of the public certificate issued by ACM to validate ownership of your custom domain. Only required when configuring mutual TLS and using an ACM imported or private CA certificate ARN as the regionalCertificateArn.

        Parameters:
        ownershipVerificationCertificateArn - The ARN of the public certificate issued by ACM to validate ownership of your custom domain. Only required when configuring mutual TLS and using an ACM imported or private CA certificate ARN as the regionalCertificateArn.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • managementPolicy

        CreateDomainNameResponse.Builder managementPolicy​(String managementPolicy)

        A stringified JSON policy document that applies to the API Gateway Management service for this DomainName. This policy document controls access for access association sources to create domain name access associations with this DomainName. Supported only for private custom domain names.

        Parameters:
        managementPolicy - A stringified JSON policy document that applies to the API Gateway Management service for this DomainName. This policy document controls access for access association sources to create domain name access associations with this DomainName. Supported only for private custom domain names.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • policy

        CreateDomainNameResponse.Builder policy​(String policy)

        A 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.

        Parameters:
        policy - A 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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.