All Implemented Interfaces:

Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class OriginAccessControlConfig
extends Object
implements Serializable, Cloneable 

See Also:

AWS API Documentation, Serialized Form

• Constructor Summary

  Constructors

  Constructor and Description
  OriginAccessControlConfig ()

• Method Summary

  All Methods

  Modifier and Type	Method and Description
  OriginAccessControlConfig	clone ()
  boolean	equals (Object obj)
  String	getDescription () A description of the origin access control.
  String	getName () A name to identify the origin access control.
  String	getOriginAccessControlOriginType () The type of origin that this origin access control is for.
  String	getSigningBehavior () Specifies which requests CloudFront signs (adds authentication information to).
  String	getSigningProtocol () The signing protocol of the origin access control, which determines how CloudFront signs (authenticates) requests.
  int	hashCode ()
  void	setDescription (String description) A description of the origin access control.
  void	setName (String name) A name to identify the origin access control.
  void	setOriginAccessControlOriginType (String originAccessControlOriginType) The type of origin that this origin access control is for.
  void	setSigningBehavior (String signingBehavior) Specifies which requests CloudFront signs (adds authentication information to).
  void	setSigningProtocol (String signingProtocol) The signing protocol of the origin access control, which determines how CloudFront signs (authenticates) requests.
  String	toString () Returns a string representation of this object.
  OriginAccessControlConfig	withDescription (String description) A description of the origin access control.
  OriginAccessControlConfig	withName (String name) A name to identify the origin access control.
  OriginAccessControlConfig	withOriginAccessControlOriginType (OriginAccessControlOriginTypes originAccessControlOriginType) The type of origin that this origin access control is for.
  OriginAccessControlConfig	withOriginAccessControlOriginType (String originAccessControlOriginType) The type of origin that this origin access control is for.
  OriginAccessControlConfig	withSigningBehavior (OriginAccessControlSigningBehaviors signingBehavior) Specifies which requests CloudFront signs (adds authentication information to).
  OriginAccessControlConfig	withSigningBehavior (String signingBehavior) Specifies which requests CloudFront signs (adds authentication information to).
  OriginAccessControlConfig	withSigningProtocol (OriginAccessControlSigningProtocols signingProtocol) The signing protocol of the origin access control, which determines how CloudFront signs (authenticates) requests.
  OriginAccessControlConfig	withSigningProtocol (String signingProtocol) The signing protocol of the origin access control, which determines how CloudFront signs (authenticates) requests.

  • Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

• Constructor Detail

  • OriginAccessControlConfig

    public OriginAccessControlConfig()

• Method Detail

  • setName

    public void setName(String name)

    A name to identify the origin access control. You can specify up to 64 characters.

    Parameters:

    name - A name to identify the origin access control. You can specify up to 64 characters.

  • getName

    public String getName()

    A name to identify the origin access control. You can specify up to 64 characters.

    Returns:

    A name to identify the origin access control. You can specify up to 64 characters.

  • withName

    public OriginAccessControlConfig withName(String name)

    A name to identify the origin access control. You can specify up to 64 characters.

    Parameters:

    name - A name to identify the origin access control. You can specify up to 64 characters.

    Returns:

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

  • setDescription

    public void setDescription(String description)

    A description of the origin access control.

    Parameters:

    description - A description of the origin access control.

  • getDescription

    public String getDescription()

    A description of the origin access control.

    Returns:

    A description of the origin access control.

  • withDescription

    public OriginAccessControlConfig withDescription(String description)

    A description of the origin access control.

    Parameters:

    description - A description of the origin access control.

    Returns:

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

  • setSigningProtocol

    public void setSigningProtocol(String signingProtocol)

    The signing protocol of the origin access control, which determines how CloudFront signs (authenticates) requests. The only valid value is sigv4.

    Parameters:

    signingProtocol - The signing protocol of the origin access control, which determines how CloudFront signs (authenticates) requests. The only valid value is sigv4.

    See Also:

    OriginAccessControlSigningProtocols

  • getSigningProtocol

    public String getSigningProtocol()

    The signing protocol of the origin access control, which determines how CloudFront signs (authenticates) requests. The only valid value is sigv4.

    Returns:

    The signing protocol of the origin access control, which determines how CloudFront signs (authenticates) requests. The only valid value is sigv4.

    See Also:

    OriginAccessControlSigningProtocols

  • withSigningProtocol

    public OriginAccessControlConfig withSigningProtocol(String signingProtocol)

    The signing protocol of the origin access control, which determines how CloudFront signs (authenticates) requests. The only valid value is sigv4.

    Parameters:

    signingProtocol - The signing protocol of the origin access control, which determines how CloudFront signs (authenticates) requests. The only valid value is sigv4.

    Returns:

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

    See Also:

    OriginAccessControlSigningProtocols

  • withSigningProtocol

    public OriginAccessControlConfig withSigningProtocol(OriginAccessControlSigningProtocols signingProtocol)

    The signing protocol of the origin access control, which determines how CloudFront signs (authenticates) requests. The only valid value is sigv4.

    Parameters:

    signingProtocol - The signing protocol of the origin access control, which determines how CloudFront signs (authenticates) requests. The only valid value is sigv4.

    Returns:

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

    See Also:

    OriginAccessControlSigningProtocols

  • setSigningBehavior

    public void setSigningBehavior(String signingBehavior)

    Specifies which requests CloudFront signs (adds authentication information to). Specify always for the most common use case. For more information, see origin access control advanced settings in the Amazon CloudFront Developer Guide.

    This field can have one of the following values:

    • always – CloudFront signs all origin requests, overwriting the Authorization header from the viewer request if one exists.

    • never – CloudFront doesn't sign any origin requests. This value turns off origin access control for all origins in all distributions that use this origin access control.

    • no-override – If the viewer request doesn't contain the Authorization header, then CloudFront signs the origin request. If the viewer request contains the Authorization header, then CloudFront doesn't sign the origin request and instead passes along the Authorization header from the viewer request. WARNING: To pass along the Authorization header from the viewer request, you must add the Authorization header to a cache policy for all cache behaviors that use origins associated with this origin access control.

    Parameters:

    signingBehavior - Specifies which requests CloudFront signs (adds authentication information to). Specify always for the most common use case. For more information, see origin access control advanced settings in the Amazon CloudFront Developer Guide.

    This field can have one of the following values:

    • always – CloudFront signs all origin requests, overwriting the Authorization header from the viewer request if one exists.

    • never – CloudFront doesn't sign any origin requests. This value turns off origin access control for all origins in all distributions that use this origin access control.

    • no-override – If the viewer request doesn't contain the Authorization header, then CloudFront signs the origin request. If the viewer request contains the Authorization header, then CloudFront doesn't sign the origin request and instead passes along the Authorization header from the viewer request. WARNING: To pass along the Authorization header from the viewer request, you must add the Authorization header to a cache policy for all cache behaviors that use origins associated with this origin access control.

    See Also:

    OriginAccessControlSigningBehaviors

  • getSigningBehavior

    public String getSigningBehavior()

    Specifies which requests CloudFront signs (adds authentication information to). Specify always for the most common use case. For more information, see origin access control advanced settings in the Amazon CloudFront Developer Guide.

    This field can have one of the following values:

    • always – CloudFront signs all origin requests, overwriting the Authorization header from the viewer request if one exists.

    • never – CloudFront doesn't sign any origin requests. This value turns off origin access control for all origins in all distributions that use this origin access control.

    • no-override – If the viewer request doesn't contain the Authorization header, then CloudFront signs the origin request. If the viewer request contains the Authorization header, then CloudFront doesn't sign the origin request and instead passes along the Authorization header from the viewer request. WARNING: To pass along the Authorization header from the viewer request, you must add the Authorization header to a cache policy for all cache behaviors that use origins associated with this origin access control.

    Returns:

    Specifies which requests CloudFront signs (adds authentication information to). Specify always for the most common use case. For more information, see origin access control advanced settings in the Amazon CloudFront Developer Guide.

    This field can have one of the following values:

    • always – CloudFront signs all origin requests, overwriting the Authorization header from the viewer request if one exists.

    • never – CloudFront doesn't sign any origin requests. This value turns off origin access control for all origins in all distributions that use this origin access control.

    • no-override – If the viewer request doesn't contain the Authorization header, then CloudFront signs the origin request. If the viewer request contains the Authorization header, then CloudFront doesn't sign the origin request and instead passes along the Authorization header from the viewer request. WARNING: To pass along the Authorization header from the viewer request, you must add the Authorization header to a cache policy for all cache behaviors that use origins associated with this origin access control.

    See Also:

    OriginAccessControlSigningBehaviors

  • withSigningBehavior

    public OriginAccessControlConfig withSigningBehavior(String signingBehavior)

    Specifies which requests CloudFront signs (adds authentication information to). Specify always for the most common use case. For more information, see origin access control advanced settings in the Amazon CloudFront Developer Guide.

    This field can have one of the following values:

    • always – CloudFront signs all origin requests, overwriting the Authorization header from the viewer request if one exists.

    • never – CloudFront doesn't sign any origin requests. This value turns off origin access control for all origins in all distributions that use this origin access control.

    • no-override – If the viewer request doesn't contain the Authorization header, then CloudFront signs the origin request. If the viewer request contains the Authorization header, then CloudFront doesn't sign the origin request and instead passes along the Authorization header from the viewer request. WARNING: To pass along the Authorization header from the viewer request, you must add the Authorization header to a cache policy for all cache behaviors that use origins associated with this origin access control.

    Parameters:

    signingBehavior - Specifies which requests CloudFront signs (adds authentication information to). Specify always for the most common use case. For more information, see origin access control advanced settings in the Amazon CloudFront Developer Guide.

    This field can have one of the following values:

    • always – CloudFront signs all origin requests, overwriting the Authorization header from the viewer request if one exists.

    • never – CloudFront doesn't sign any origin requests. This value turns off origin access control for all origins in all distributions that use this origin access control.

    • no-override – If the viewer request doesn't contain the Authorization header, then CloudFront signs the origin request. If the viewer request contains the Authorization header, then CloudFront doesn't sign the origin request and instead passes along the Authorization header from the viewer request. WARNING: To pass along the Authorization header from the viewer request, you must add the Authorization header to a cache policy for all cache behaviors that use origins associated with this origin access control.

    Returns:

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

    See Also:

    OriginAccessControlSigningBehaviors

  • withSigningBehavior

    public OriginAccessControlConfig withSigningBehavior(OriginAccessControlSigningBehaviors signingBehavior)

    Specifies which requests CloudFront signs (adds authentication information to). Specify always for the most common use case. For more information, see origin access control advanced settings in the Amazon CloudFront Developer Guide.

    This field can have one of the following values:

    • always – CloudFront signs all origin requests, overwriting the Authorization header from the viewer request if one exists.

    • never – CloudFront doesn't sign any origin requests. This value turns off origin access control for all origins in all distributions that use this origin access control.

    • no-override – If the viewer request doesn't contain the Authorization header, then CloudFront signs the origin request. If the viewer request contains the Authorization header, then CloudFront doesn't sign the origin request and instead passes along the Authorization header from the viewer request. WARNING: To pass along the Authorization header from the viewer request, you must add the Authorization header to a cache policy for all cache behaviors that use origins associated with this origin access control.

    Parameters:

    signingBehavior - Specifies which requests CloudFront signs (adds authentication information to). Specify always for the most common use case. For more information, see origin access control advanced settings in the Amazon CloudFront Developer Guide.

    This field can have one of the following values:

    • always – CloudFront signs all origin requests, overwriting the Authorization header from the viewer request if one exists.

    • never – CloudFront doesn't sign any origin requests. This value turns off origin access control for all origins in all distributions that use this origin access control.

    • no-override – If the viewer request doesn't contain the Authorization header, then CloudFront signs the origin request. If the viewer request contains the Authorization header, then CloudFront doesn't sign the origin request and instead passes along the Authorization header from the viewer request. WARNING: To pass along the Authorization header from the viewer request, you must add the Authorization header to a cache policy for all cache behaviors that use origins associated with this origin access control.

    Returns:

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

    See Also:

    OriginAccessControlSigningBehaviors

  • setOriginAccessControlOriginType

    public void setOriginAccessControlOriginType(String originAccessControlOriginType)

    The type of origin that this origin access control is for.

    Parameters:

    originAccessControlOriginType - The type of origin that this origin access control is for.

    See Also:

    OriginAccessControlOriginTypes

  • getOriginAccessControlOriginType

    public String getOriginAccessControlOriginType()

    The type of origin that this origin access control is for.

    Returns:

    The type of origin that this origin access control is for.

    See Also:

    OriginAccessControlOriginTypes

  • withOriginAccessControlOriginType

    public OriginAccessControlConfig withOriginAccessControlOriginType(String originAccessControlOriginType)

    The type of origin that this origin access control is for.

    Parameters:

    originAccessControlOriginType - The type of origin that this origin access control is for.

    Returns:

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

    See Also:

    OriginAccessControlOriginTypes

  • withOriginAccessControlOriginType

    public OriginAccessControlConfig withOriginAccessControlOriginType(OriginAccessControlOriginTypes originAccessControlOriginType)

    The type of origin that this origin access control is for.

    Parameters:

    originAccessControlOriginType - The type of origin that this origin access control is for.

    Returns:

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

    See Also:

    OriginAccessControlOriginTypes

  • toString

    public String 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.

    Overrides:

    toString in class Object

    Returns:

    A string representation of this object.

    See Also:

    Object.toString()

  • equals

    public boolean equals(Object obj)

    Overrides:

    equals in class Object

  • hashCode

    public int hashCode()

    Overrides:

    hashCode in class Object

  • clone

    public OriginAccessControlConfig clone()

    Overrides:

    clone in class Object