Interface Origin.Builder
-
- All Superinterfaces:
Buildable,CopyableBuilder<Origin.Builder,Origin>,SdkBuilder<Origin.Builder,Origin>,SdkPojo
- Enclosing class:
- Origin
@Mutable @NotThreadSafe public static interface Origin.Builder extends SdkPojo, CopyableBuilder<Origin.Builder,Origin>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description Origin.BuilderconnectionAttempts(Integer connectionAttempts)The number of times that CloudFront attempts to connect to the origin.Origin.BuilderconnectionTimeout(Integer connectionTimeout)The number of seconds that CloudFront waits when trying to establish a connection to the origin.default Origin.BuildercustomHeaders(Consumer<CustomHeaders.Builder> customHeaders)A list of HTTP header names and values that CloudFront adds to the requests that it sends to the origin.Origin.BuildercustomHeaders(CustomHeaders customHeaders)A list of HTTP header names and values that CloudFront adds to the requests that it sends to the origin.default Origin.BuildercustomOriginConfig(Consumer<CustomOriginConfig.Builder> customOriginConfig)Use this type to specify an origin that is not an Amazon S3 bucket, with one exception.Origin.BuildercustomOriginConfig(CustomOriginConfig customOriginConfig)Use this type to specify an origin that is not an Amazon S3 bucket, with one exception.Origin.BuilderdomainName(String domainName)The domain name for the origin.Origin.Builderid(String id)A unique identifier for the origin.Origin.BuilderoriginAccessControlId(String originAccessControlId)The unique identifier of an origin access control for this origin.Origin.BuilderoriginPath(String originPath)An optional path that CloudFront appends to the origin domain name when CloudFront requests content from the origin.default Origin.BuilderoriginShield(Consumer<OriginShield.Builder> originShield)CloudFront Origin Shield.Origin.BuilderoriginShield(OriginShield originShield)CloudFront Origin Shield.Origin.BuilderresponseCompletionTimeout(Integer responseCompletionTimeout)The time (in seconds) that a request from CloudFront to the origin can stay open and wait for a response.default Origin.Builders3OriginConfig(Consumer<S3OriginConfig.Builder> s3OriginConfig)Use this type to specify an origin that is an Amazon S3 bucket that is not configured with static website hosting.Origin.Builders3OriginConfig(S3OriginConfig s3OriginConfig)Use this type to specify an origin that is an Amazon S3 bucket that is not configured with static website hosting.default Origin.BuildervpcOriginConfig(Consumer<VpcOriginConfig.Builder> vpcOriginConfig)The VPC origin configuration.Origin.BuildervpcOriginConfig(VpcOriginConfig vpcOriginConfig)The VPC origin configuration.-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
-
-
-
Method Detail
-
id
Origin.Builder id(String id)
A unique identifier for the origin. This value must be unique within the distribution.
Use this value to specify the
TargetOriginIdin aCacheBehaviororDefaultCacheBehavior.- Parameters:
id- A unique identifier for the origin. This value must be unique within the distribution.Use this value to specify the
TargetOriginIdin aCacheBehaviororDefaultCacheBehavior.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
domainName
Origin.Builder domainName(String domainName)
The domain name for the origin.
For more information, see Origin Domain Name in the Amazon CloudFront Developer Guide.
- Parameters:
domainName- The domain name for the origin.For more information, see Origin Domain Name in the Amazon CloudFront Developer Guide.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
originPath
Origin.Builder originPath(String originPath)
An optional path that CloudFront appends to the origin domain name when CloudFront requests content from the origin.
For more information, see Origin Path in the Amazon CloudFront Developer Guide.
- Parameters:
originPath- An optional path that CloudFront appends to the origin domain name when CloudFront requests content from the origin.For more information, see Origin Path in the Amazon CloudFront Developer Guide.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
customHeaders
Origin.Builder customHeaders(CustomHeaders customHeaders)
A list of HTTP header names and values that CloudFront adds to the requests that it sends to the origin.
For more information, see Adding Custom Headers to Origin Requests in the Amazon CloudFront Developer Guide.
- Parameters:
customHeaders- A list of HTTP header names and values that CloudFront adds to the requests that it sends to the origin.For more information, see Adding Custom Headers to Origin Requests in the Amazon CloudFront Developer Guide.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
customHeaders
default Origin.Builder customHeaders(Consumer<CustomHeaders.Builder> customHeaders)
A list of HTTP header names and values that CloudFront adds to the requests that it sends to the origin.
For more information, see Adding Custom Headers to Origin Requests in the Amazon CloudFront Developer Guide.
This is a convenience method that creates an instance of theCustomHeaders.Builderavoiding the need to create one manually viaCustomHeaders.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tocustomHeaders(CustomHeaders).- Parameters:
customHeaders- a consumer that will call methods onCustomHeaders.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
customHeaders(CustomHeaders)
-
s3OriginConfig
Origin.Builder s3OriginConfig(S3OriginConfig s3OriginConfig)
Use this type to specify an origin that is an Amazon S3 bucket that is not configured with static website hosting. To specify any other type of origin, including an Amazon S3 bucket that is configured with static website hosting, use the
CustomOriginConfigtype instead.- Parameters:
s3OriginConfig- Use this type to specify an origin that is an Amazon S3 bucket that is not configured with static website hosting. To specify any other type of origin, including an Amazon S3 bucket that is configured with static website hosting, use theCustomOriginConfigtype instead.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
s3OriginConfig
default Origin.Builder s3OriginConfig(Consumer<S3OriginConfig.Builder> s3OriginConfig)
Use this type to specify an origin that is an Amazon S3 bucket that is not configured with static website hosting. To specify any other type of origin, including an Amazon S3 bucket that is configured with static website hosting, use the
This is a convenience method that creates an instance of theCustomOriginConfigtype instead.S3OriginConfig.Builderavoiding the need to create one manually viaS3OriginConfig.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tos3OriginConfig(S3OriginConfig).- Parameters:
s3OriginConfig- a consumer that will call methods onS3OriginConfig.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
s3OriginConfig(S3OriginConfig)
-
customOriginConfig
Origin.Builder customOriginConfig(CustomOriginConfig customOriginConfig)
Use this type to specify an origin that is not an Amazon S3 bucket, with one exception. If the Amazon S3 bucket is configured with static website hosting, use this type. If the Amazon S3 bucket is not configured with static website hosting, use the
S3OriginConfigtype instead.- Parameters:
customOriginConfig- Use this type to specify an origin that is not an Amazon S3 bucket, with one exception. If the Amazon S3 bucket is configured with static website hosting, use this type. If the Amazon S3 bucket is not configured with static website hosting, use theS3OriginConfigtype instead.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
customOriginConfig
default Origin.Builder customOriginConfig(Consumer<CustomOriginConfig.Builder> customOriginConfig)
Use this type to specify an origin that is not an Amazon S3 bucket, with one exception. If the Amazon S3 bucket is configured with static website hosting, use this type. If the Amazon S3 bucket is not configured with static website hosting, use the
This is a convenience method that creates an instance of theS3OriginConfigtype instead.CustomOriginConfig.Builderavoiding the need to create one manually viaCustomOriginConfig.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tocustomOriginConfig(CustomOriginConfig).- Parameters:
customOriginConfig- a consumer that will call methods onCustomOriginConfig.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
customOriginConfig(CustomOriginConfig)
-
vpcOriginConfig
Origin.Builder vpcOriginConfig(VpcOriginConfig vpcOriginConfig)
The VPC origin configuration.
- Parameters:
vpcOriginConfig- The VPC origin configuration.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
vpcOriginConfig
default Origin.Builder vpcOriginConfig(Consumer<VpcOriginConfig.Builder> vpcOriginConfig)
The VPC origin configuration.
This is a convenience method that creates an instance of theVpcOriginConfig.Builderavoiding the need to create one manually viaVpcOriginConfig.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tovpcOriginConfig(VpcOriginConfig).- Parameters:
vpcOriginConfig- a consumer that will call methods onVpcOriginConfig.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
vpcOriginConfig(VpcOriginConfig)
-
connectionAttempts
Origin.Builder connectionAttempts(Integer connectionAttempts)
The number of times that CloudFront attempts to connect to the origin. The minimum number is 1, the maximum is 3, and the default (if you don't specify otherwise) is 3.
For a custom origin (including an Amazon S3 bucket that's configured with static website hosting), this value also specifies the number of times that CloudFront attempts to get a response from the origin, in the case of an Origin Response Timeout.
For more information, see Origin Connection Attempts in the Amazon CloudFront Developer Guide.
- Parameters:
connectionAttempts- The number of times that CloudFront attempts to connect to the origin. The minimum number is 1, the maximum is 3, and the default (if you don't specify otherwise) is 3.For a custom origin (including an Amazon S3 bucket that's configured with static website hosting), this value also specifies the number of times that CloudFront attempts to get a response from the origin, in the case of an Origin Response Timeout.
For more information, see Origin Connection Attempts in the Amazon CloudFront Developer Guide.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
connectionTimeout
Origin.Builder connectionTimeout(Integer connectionTimeout)
The number of seconds that CloudFront waits when trying to establish a connection to the origin. The minimum timeout is 1 second, the maximum is 10 seconds, and the default (if you don't specify otherwise) is 10 seconds.
For more information, see Origin Connection Timeout in the Amazon CloudFront Developer Guide.
- Parameters:
connectionTimeout- The number of seconds that CloudFront waits when trying to establish a connection to the origin. The minimum timeout is 1 second, the maximum is 10 seconds, and the default (if you don't specify otherwise) is 10 seconds.For more information, see Origin Connection Timeout in the Amazon CloudFront Developer Guide.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
responseCompletionTimeout
Origin.Builder responseCompletionTimeout(Integer responseCompletionTimeout)
The time (in seconds) that a request from CloudFront to the origin can stay open and wait for a response. If the complete response isn't received from the origin by this time, CloudFront ends the connection.
The value for
ResponseCompletionTimeoutmust be equal to or greater than the value forOriginReadTimeout. If you don't set a value forResponseCompletionTimeout, CloudFront doesn't enforce a maximum value.For more information, see Response completion timeout in the Amazon CloudFront Developer Guide.
- Parameters:
responseCompletionTimeout- The time (in seconds) that a request from CloudFront to the origin can stay open and wait for a response. If the complete response isn't received from the origin by this time, CloudFront ends the connection.The value for
ResponseCompletionTimeoutmust be equal to or greater than the value forOriginReadTimeout. If you don't set a value forResponseCompletionTimeout, CloudFront doesn't enforce a maximum value.For more information, see Response completion timeout in the Amazon CloudFront Developer Guide.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
originShield
Origin.Builder originShield(OriginShield originShield)
CloudFront Origin Shield. Using Origin Shield can help reduce the load on your origin.
For more information, see Using Origin Shield in the Amazon CloudFront Developer Guide.
- Parameters:
originShield- CloudFront Origin Shield. Using Origin Shield can help reduce the load on your origin.For more information, see Using Origin Shield in the Amazon CloudFront Developer Guide.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
originShield
default Origin.Builder originShield(Consumer<OriginShield.Builder> originShield)
CloudFront Origin Shield. Using Origin Shield can help reduce the load on your origin.
For more information, see Using Origin Shield in the Amazon CloudFront Developer Guide.
This is a convenience method that creates an instance of theOriginShield.Builderavoiding the need to create one manually viaOriginShield.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tooriginShield(OriginShield).- Parameters:
originShield- a consumer that will call methods onOriginShield.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
originShield(OriginShield)
-
originAccessControlId
Origin.Builder originAccessControlId(String originAccessControlId)
The unique identifier of an origin access control for this origin.
For more information, see Restricting access to an Amazon S3 origin in the Amazon CloudFront Developer Guide.
- Parameters:
originAccessControlId- The unique identifier of an origin access control for this origin.For more information, see Restricting access to an Amazon S3 origin in the Amazon CloudFront Developer Guide.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-