software.amazon.awssdk.services.apigateway.model

Interface CreateDomainNameRequest.Builder

All Superinterfaces:

ApiGatewayRequest.Builder, AwsRequest.Builder, CopyableBuilder<CreateDomainNameRequest.Builder,CreateDomainNameRequest>, SdkBuilder<CreateDomainNameRequest.Builder,CreateDomainNameRequest>, SdkRequest.Builder

Enclosing class:

CreateDomainNameRequest

public static interface CreateDomainNameRequest.Builder
extends ApiGatewayRequest.Builder, CopyableBuilder<CreateDomainNameRequest.Builder,CreateDomainNameRequest>

Method Summary

Modifier and Type	Method and Description
CreateDomainNameRequest.Builder	certificateArn(String certificateArn) The reference to an AWS-managed certificate that will be used by edge-optimized endpoint for this domain name.
CreateDomainNameRequest.Builder	certificateBody(String certificateBody) [Deprecated] The body of the server certificate that will be used by edge-optimized endpoint for this domain name provided by your certificate authority.
CreateDomainNameRequest.Builder	certificateChain(String certificateChain) [Deprecated] The intermediate certificates and optionally the root certificate, one after the other without any blank lines, used by an edge-optimized endpoint for this domain name.
CreateDomainNameRequest.Builder	certificateName(String certificateName) The user-friendly name of the certificate that will be used by edge-optimized endpoint for this domain name.
CreateDomainNameRequest.Builder	certificatePrivateKey(String certificatePrivateKey) [Deprecated] Your edge-optimized endpoint's domain name certificate's private key.
CreateDomainNameRequest.Builder	domainName(String domainName) (Required) The name of the DomainName resource.
default CreateDomainNameRequest.Builder	endpointConfiguration(Consumer<EndpointConfiguration.Builder> endpointConfiguration) The endpoint configuration of this DomainName showing the endpoint types of the domain name.
CreateDomainNameRequest.Builder	endpointConfiguration(EndpointConfiguration endpointConfiguration) The endpoint configuration of this DomainName showing the endpoint types of the domain name.
CreateDomainNameRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
CreateDomainNameRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
CreateDomainNameRequest.Builder	regionalCertificateArn(String regionalCertificateArn) The reference to an AWS-managed certificate that will be used by regional endpoint for this domain name.
CreateDomainNameRequest.Builder	regionalCertificateName(String regionalCertificateName) The user-friendly name of the certificate that will be used by regional endpoint for this domain name.

Methods inherited from interface software.amazon.awssdk.services.apigateway.model.ApiGatewayRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

domainName

CreateDomainNameRequest.Builder domainName(String domainName)

(Required) The name of the DomainName resource.

Parameters:

domainName - (Required) The name of the DomainName resource.

Returns:

Returns a reference to this object so that method calls can be chained together.

certificateName

CreateDomainNameRequest.Builder certificateName(String certificateName)

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

Parameters:

certificateName - The user-friendly name of the certificate that will be used by edge-optimized endpoint for this domain name.

Returns:

Returns a reference to this object so that method calls can be chained together.

certificateBody

CreateDomainNameRequest.Builder certificateBody(String certificateBody)

[Deprecated] The body of the server certificate that will be used by edge-optimized endpoint for this domain name provided by your certificate authority.

Parameters:

certificateBody - [Deprecated] The body of the server certificate that will be used by edge-optimized endpoint for this domain name provided by your certificate authority.

Returns:

Returns a reference to this object so that method calls can be chained together.

certificatePrivateKey

CreateDomainNameRequest.Builder certificatePrivateKey(String certificatePrivateKey)

[Deprecated] Your edge-optimized endpoint's domain name certificate's private key.

Parameters:

certificatePrivateKey - [Deprecated] Your edge-optimized endpoint's domain name certificate's private key.

Returns:

Returns a reference to this object so that method calls can be chained together.

certificateChain

CreateDomainNameRequest.Builder certificateChain(String certificateChain)

[Deprecated] The intermediate certificates and optionally the root certificate, one after the other without any blank lines, used by an edge-optimized endpoint for this domain name. If you include the root certificate, your certificate chain must start with intermediate certificates and end with the root certificate. Use the intermediate certificates that were provided by your certificate authority. Do not include any intermediaries that are not in the chain of trust path.

Parameters:

certificateChain - [Deprecated] The intermediate certificates and optionally the root certificate, one after the other without any blank lines, used by an edge-optimized endpoint for this domain name. If you include the root certificate, your certificate chain must start with intermediate certificates and end with the root certificate. Use the intermediate certificates that were provided by your certificate authority. Do not include any intermediaries that are not in the chain of trust path.

Returns:

Returns a reference to this object so that method calls can be chained together.

certificateArn

CreateDomainNameRequest.Builder certificateArn(String certificateArn)

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

Parameters:

certificateArn - The reference to an AWS-managed certificate that will be used by edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.

Returns:

Returns a reference to this object so that method calls can be chained together.

regionalCertificateName

CreateDomainNameRequest.Builder regionalCertificateName(String regionalCertificateName)

The user-friendly name of the certificate that will be used by regional endpoint for this domain name.

Parameters:

regionalCertificateName - The user-friendly name of the certificate that will be used by regional endpoint for this domain name.

Returns:

Returns a reference to this object so that method calls can be chained together.

regionalCertificateArn

CreateDomainNameRequest.Builder regionalCertificateArn(String regionalCertificateArn)

The reference to an AWS-managed certificate that will be used by regional endpoint for this domain name. AWS Certificate Manager is the only supported source.

Parameters:

regionalCertificateArn - The reference to an AWS-managed certificate that will be used by regional endpoint for this domain name. AWS Certificate Manager is the only supported source.

Returns:

Returns a reference to this object so that method calls can be chained together.

endpointConfiguration

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

endpointConfiguration

default CreateDomainNameRequest.Builder endpointConfiguration(Consumer<EndpointConfiguration.Builder> endpointConfiguration)

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

This is a convenience that creates an instance of the EndpointConfiguration.Builder avoiding the need to create one manually via EndpointConfiguration.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to endpointConfiguration(EndpointConfiguration).

Parameters:

endpointConfiguration - a consumer that will call methods on EndpointConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

endpointConfiguration(EndpointConfiguration)

overrideConfiguration

CreateDomainNameRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

CreateDomainNameRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.