Class OriginAccessControlSummary
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<OriginAccessControlSummary.Builder,
OriginAccessControlSummary>
A CloudFront origin access control.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
A description of the origin access control.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final String
id()
The unique identifier of the origin access control.final String
name()
A unique name that identifies the origin access control.The type of origin that this origin access control is for.final String
The type of origin that this origin access control is for.static Class
<? extends OriginAccessControlSummary.Builder> A value that specifies which requests CloudFront signs (adds authentication information to).final String
A value that specifies which requests CloudFront signs (adds authentication information to).The signing protocol of the origin access control.final String
The signing protocol of the origin access control.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
id
The unique identifier of the origin access control.
- Returns:
- The unique identifier of the origin access control.
-
description
A description of the origin access control.
- Returns:
- A description of the origin access control.
-
name
A unique name that identifies the origin access control.
- Returns:
- A unique name that identifies the origin access control.
-
signingProtocol
The signing protocol of the origin access control. The signing protocol determines how CloudFront signs (authenticates) requests. The only valid value is
sigv4
.If the service returns an enum value that is not available in the current SDK version,
signingProtocol
will returnOriginAccessControlSigningProtocols.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsigningProtocolAsString()
.- Returns:
- The signing protocol of the origin access control. The signing protocol determines how CloudFront signs
(authenticates) requests. The only valid value is
sigv4
. - See Also:
-
signingProtocolAsString
The signing protocol of the origin access control. The signing protocol determines how CloudFront signs (authenticates) requests. The only valid value is
sigv4
.If the service returns an enum value that is not available in the current SDK version,
signingProtocol
will returnOriginAccessControlSigningProtocols.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsigningProtocolAsString()
.- Returns:
- The signing protocol of the origin access control. The signing protocol determines how CloudFront signs
(authenticates) requests. The only valid value is
sigv4
. - See Also:
-
signingBehavior
A value that specifies which requests CloudFront signs (adds authentication information to). This field can have one of the following values:
-
never
– CloudFront doesn't sign any origin requests. -
always
– CloudFront signs all origin requests, overwriting theAuthorization
header from the viewer request if necessary. -
no-override
– If the viewer request doesn't contain theAuthorization
header, CloudFront signs the origin request. If the viewer request contains theAuthorization
header, CloudFront doesn't sign the origin request, but instead passes along theAuthorization
header that it received in the viewer request.
If the service returns an enum value that is not available in the current SDK version,
signingBehavior
will returnOriginAccessControlSigningBehaviors.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsigningBehaviorAsString()
.- Returns:
- A value that specifies which requests CloudFront signs (adds authentication information to). This field
can have one of the following values:
-
never
– CloudFront doesn't sign any origin requests. -
always
– CloudFront signs all origin requests, overwriting theAuthorization
header from the viewer request if necessary. -
no-override
– If the viewer request doesn't contain theAuthorization
header, CloudFront signs the origin request. If the viewer request contains theAuthorization
header, CloudFront doesn't sign the origin request, but instead passes along theAuthorization
header that it received in the viewer request.
-
- See Also:
-
-
signingBehaviorAsString
A value that specifies which requests CloudFront signs (adds authentication information to). This field can have one of the following values:
-
never
– CloudFront doesn't sign any origin requests. -
always
– CloudFront signs all origin requests, overwriting theAuthorization
header from the viewer request if necessary. -
no-override
– If the viewer request doesn't contain theAuthorization
header, CloudFront signs the origin request. If the viewer request contains theAuthorization
header, CloudFront doesn't sign the origin request, but instead passes along theAuthorization
header that it received in the viewer request.
If the service returns an enum value that is not available in the current SDK version,
signingBehavior
will returnOriginAccessControlSigningBehaviors.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsigningBehaviorAsString()
.- Returns:
- A value that specifies which requests CloudFront signs (adds authentication information to). This field
can have one of the following values:
-
never
– CloudFront doesn't sign any origin requests. -
always
– CloudFront signs all origin requests, overwriting theAuthorization
header from the viewer request if necessary. -
no-override
– If the viewer request doesn't contain theAuthorization
header, CloudFront signs the origin request. If the viewer request contains theAuthorization
header, CloudFront doesn't sign the origin request, but instead passes along theAuthorization
header that it received in the viewer request.
-
- See Also:
-
-
originAccessControlOriginType
The type of origin that this origin access control is for.
If the service returns an enum value that is not available in the current SDK version,
originAccessControlOriginType
will returnOriginAccessControlOriginTypes.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromoriginAccessControlOriginTypeAsString()
.- Returns:
- The type of origin that this origin access control is for.
- See Also:
-
originAccessControlOriginTypeAsString
The type of origin that this origin access control is for.
If the service returns an enum value that is not available in the current SDK version,
originAccessControlOriginType
will returnOriginAccessControlOriginTypes.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromoriginAccessControlOriginTypeAsString()
.- Returns:
- The type of origin that this origin access control is for.
- See Also:
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<OriginAccessControlSummary.Builder,
OriginAccessControlSummary> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
-
sdkFields
-