Skip to content

OriginAccessControlSummary

Source code in docs_src/capo_cloudfront/types/origin_access_control_summary.py
class OriginAccessControlSummary(TypedDict, closed=True):
    id: "capo_cloudfront.types.string.string"
    """<p>The unique identifier of the origin access control.</p>"""
    description: "capo_cloudfront.types.string.string"
    """<p>A description of the origin access control.</p>"""
    name: "capo_cloudfront.types.string.string"
    """<p>A unique name that identifies the origin access control.</p>"""
    signing_protocol: "capo_cloudfront.types.origin_access_control_signing_protocols.OriginAccessControlSigningProtocols"
    """<p>The signing protocol of the origin access control. The signing protocol determines how CloudFront signs (authenticates) requests. The only valid values are <code>sigv4</code> and <code>sigv4a</code>.</p>"""
    signing_behavior: "capo_cloudfront.types.origin_access_control_signing_behaviors.OriginAccessControlSigningBehaviors"
    """<p>A value that specifies which requests CloudFront signs (adds authentication information to). This field can have one of the following values:</p> <ul> <li> <p> <code>never</code> – CloudFront doesn't sign any origin requests.</p> </li> <li> <p> <code>always</code> – CloudFront signs all origin requests, overwriting the <code>Authorization</code> header from the viewer request if necessary.</p> </li> <li> <p> <code>no-override</code> – If the viewer request doesn't contain the <code>Authorization</code> header, CloudFront signs the origin request. If the viewer request contains the <code>Authorization</code> header, CloudFront doesn't sign the origin request, but instead passes along the <code>Authorization</code> header that it received in the viewer request.</p> </li> <li> <p> <code>always-amz-auth</code> – CloudFront signs all origin requests with Amazon authentication headers, and forwards the viewer's <code>Authorization</code> header to the origin if one is present. This value is only valid with Lambda-Web origins.</p> </li> </ul>"""
    origin_access_control_origin_type: "capo_cloudfront.types.origin_access_control_origin_types.OriginAccessControlOriginTypes"
    """<p>The type of origin that this origin access control is for.</p>"""

description instance-attribute

description: string

A description of the origin access control.

id instance-attribute

id: string

The unique identifier of the origin access control.

name instance-attribute

name: string

A unique name that identifies the origin access control.

origin_access_control_origin_type instance-attribute

origin_access_control_origin_type: OriginAccessControlOriginTypes

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

signing_behavior instance-attribute

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 the Authorization header from the viewer request if necessary.

  • no-override – If the viewer request doesn't contain the Authorization header, CloudFront signs the origin request. If the viewer request contains the Authorization header, CloudFront doesn't sign the origin request, but instead passes along the Authorization header that it received in the viewer request.

  • always-amz-auth – CloudFront signs all origin requests with Amazon authentication headers, and forwards the viewer's Authorization header to the origin if one is present. This value is only valid with Lambda-Web origins.

signing_protocol instance-attribute

The signing protocol of the origin access control. The signing protocol determines how CloudFront signs (authenticates) requests. The only valid values are sigv4 and sigv4a.