Amazon CloudFront

2026/10/14 - Amazon CloudFront - 5 updated api methods

Changes  This release adds a new "IpAddressType" field to "VPCOriginEndpointConfig", allowing customers to specify whether their VPC origin accepts IPv4-only or dualstack connections.

CreateVpcOrigin (updated) Link ¶
Changes (request, response)
Request
{'VpcOriginEndpointConfig': {'IpAddressType': 'ipv4 | dualstack'}}
Response
{'VpcOrigin': {'VpcOriginEndpointConfig': {'IpAddressType': 'ipv4 | '
                                                            'dualstack'}}}

Create an Amazon CloudFront VPC origin.

See also: AWS API Documentation

Request Syntax

client.create_vpc_origin(
    VpcOriginEndpointConfig={
        'Name': 'string',
        'Arn': 'string',
        'HTTPPort': 123,
        'HTTPSPort': 123,
        'OriginProtocolPolicy': 'http-only'|'match-viewer'|'https-only',
        'OriginSslProtocols': {
            'Quantity': 123,
            'Items': [
                'SSLv3'|'TLSv1'|'TLSv1.1'|'TLSv1.2',
            ]
        },
        'IpAddressType': 'ipv4'|'dualstack'
    },
    Tags={
        'Items': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
)
type VpcOriginEndpointConfig:

dict

param VpcOriginEndpointConfig:

[REQUIRED]

The VPC origin endpoint configuration.

  • Name (string) -- [REQUIRED]

    The name of the CloudFront VPC origin endpoint configuration.

  • Arn (string) -- [REQUIRED]

    The ARN of the CloudFront VPC origin endpoint configuration.

  • HTTPPort (integer) -- [REQUIRED]

    The HTTP port for the CloudFront VPC origin endpoint configuration. The default value is 80.

  • HTTPSPort (integer) -- [REQUIRED]

    The HTTPS port of the CloudFront VPC origin endpoint configuration. The default value is 443.

  • OriginProtocolPolicy (string) -- [REQUIRED]

    The origin protocol policy for the CloudFront VPC origin endpoint configuration.

  • OriginSslProtocols (dict) --

    A complex type that contains information about the SSL/TLS protocols that CloudFront can use when establishing an HTTPS connection with your origin.

    • Quantity (integer) -- [REQUIRED]

      The number of SSL/TLS protocols that you want to allow CloudFront to use when establishing an HTTPS connection with this origin.

    • Items (list) -- [REQUIRED]

      A list that contains allowed SSL/TLS protocols for this distribution.

      • (string) --

  • IpAddressType (string) --

    The IP address type of the CloudFront VPC origin endpoint configuration. Valid values are ipv4 and dualstack. IPv6-only is not supported for VPC origins.

type Tags:

dict

param Tags:

A complex type that contains zero or more Tag elements.

  • Items (list) --

    A complex type that contains Tag elements.

    • (dict) --

      A complex type that contains Tag key and Tag value.

      • Key (string) -- [REQUIRED]

        A string that contains Tag key.

        The string length should be between 1 and 128 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @.

      • Value (string) --

        A string that contains an optional Tag value.

        The string length should be between 0 and 256 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @.

rtype:

dict

returns:

Response Syntax

{
    'VpcOrigin': {
        'Id': 'string',
        'Arn': 'string',
        'AccountId': 'string',
        'Status': 'string',
        'CreatedTime': datetime(2015, 1, 1),
        'LastModifiedTime': datetime(2015, 1, 1),
        'VpcOriginEndpointConfig': {
            'Name': 'string',
            'Arn': 'string',
            'HTTPPort': 123,
            'HTTPSPort': 123,
            'OriginProtocolPolicy': 'http-only'|'match-viewer'|'https-only',
            'OriginSslProtocols': {
                'Quantity': 123,
                'Items': [
                    'SSLv3'|'TLSv1'|'TLSv1.1'|'TLSv1.2',
                ]
            },
            'IpAddressType': 'ipv4'|'dualstack'
        }
    },
    'Location': 'string',
    'ETag': 'string'
}

Response Structure

  • (dict) --

    • VpcOrigin (dict) --

      The VPC origin.

      • Id (string) --

        The VPC origin ID.

      • Arn (string) --

        The VPC origin ARN.

      • AccountId (string) --

        The account ID of the Amazon Web Services account that owns the VPC origin.

      • Status (string) --

        The VPC origin status.

      • CreatedTime (datetime) --

        The VPC origin created time.

      • LastModifiedTime (datetime) --

        The VPC origin last modified time.

      • VpcOriginEndpointConfig (dict) --

        The VPC origin endpoint configuration.

        • Name (string) --

          The name of the CloudFront VPC origin endpoint configuration.

        • Arn (string) --

          The ARN of the CloudFront VPC origin endpoint configuration.

        • HTTPPort (integer) --

          The HTTP port for the CloudFront VPC origin endpoint configuration. The default value is 80.

        • HTTPSPort (integer) --

          The HTTPS port of the CloudFront VPC origin endpoint configuration. The default value is 443.

        • OriginProtocolPolicy (string) --

          The origin protocol policy for the CloudFront VPC origin endpoint configuration.

        • OriginSslProtocols (dict) --

          A complex type that contains information about the SSL/TLS protocols that CloudFront can use when establishing an HTTPS connection with your origin.

          • Quantity (integer) --

            The number of SSL/TLS protocols that you want to allow CloudFront to use when establishing an HTTPS connection with this origin.

          • Items (list) --

            A list that contains allowed SSL/TLS protocols for this distribution.

            • (string) --

        • IpAddressType (string) --

          The IP address type of the CloudFront VPC origin endpoint configuration. Valid values are ipv4 and dualstack. IPv6-only is not supported for VPC origins.

    • Location (string) --

      The VPC origin location.

    • ETag (string) --

      The VPC origin ETag.

DeleteVpcOrigin (updated) Link ¶
Changes (response)
{'VpcOrigin': {'VpcOriginEndpointConfig': {'IpAddressType': 'ipv4 | '
                                                            'dualstack'}}}

Delete an Amazon CloudFront VPC origin.

See also: AWS API Documentation

Request Syntax

client.delete_vpc_origin(
    Id='string',
    IfMatch='string'
)
type Id:

string

param Id:

[REQUIRED]

The VPC origin ID.

type IfMatch:

string

param IfMatch:

[REQUIRED]

The version identifier of the VPC origin to delete. This is the ETag value returned in the response to GetVpcOrigin.

rtype:

dict

returns:

Response Syntax

{
    'VpcOrigin': {
        'Id': 'string',
        'Arn': 'string',
        'AccountId': 'string',
        'Status': 'string',
        'CreatedTime': datetime(2015, 1, 1),
        'LastModifiedTime': datetime(2015, 1, 1),
        'VpcOriginEndpointConfig': {
            'Name': 'string',
            'Arn': 'string',
            'HTTPPort': 123,
            'HTTPSPort': 123,
            'OriginProtocolPolicy': 'http-only'|'match-viewer'|'https-only',
            'OriginSslProtocols': {
                'Quantity': 123,
                'Items': [
                    'SSLv3'|'TLSv1'|'TLSv1.1'|'TLSv1.2',
                ]
            },
            'IpAddressType': 'ipv4'|'dualstack'
        }
    },
    'ETag': 'string'
}

Response Structure

  • (dict) --

    • VpcOrigin (dict) --

      The VPC origin.

      • Id (string) --

        The VPC origin ID.

      • Arn (string) --

        The VPC origin ARN.

      • AccountId (string) --

        The account ID of the Amazon Web Services account that owns the VPC origin.

      • Status (string) --

        The VPC origin status.

      • CreatedTime (datetime) --

        The VPC origin created time.

      • LastModifiedTime (datetime) --

        The VPC origin last modified time.

      • VpcOriginEndpointConfig (dict) --

        The VPC origin endpoint configuration.

        • Name (string) --

          The name of the CloudFront VPC origin endpoint configuration.

        • Arn (string) --

          The ARN of the CloudFront VPC origin endpoint configuration.

        • HTTPPort (integer) --

          The HTTP port for the CloudFront VPC origin endpoint configuration. The default value is 80.

        • HTTPSPort (integer) --

          The HTTPS port of the CloudFront VPC origin endpoint configuration. The default value is 443.

        • OriginProtocolPolicy (string) --

          The origin protocol policy for the CloudFront VPC origin endpoint configuration.

        • OriginSslProtocols (dict) --

          A complex type that contains information about the SSL/TLS protocols that CloudFront can use when establishing an HTTPS connection with your origin.

          • Quantity (integer) --

            The number of SSL/TLS protocols that you want to allow CloudFront to use when establishing an HTTPS connection with this origin.

          • Items (list) --

            A list that contains allowed SSL/TLS protocols for this distribution.

            • (string) --

        • IpAddressType (string) --

          The IP address type of the CloudFront VPC origin endpoint configuration. Valid values are ipv4 and dualstack. IPv6-only is not supported for VPC origins.

    • ETag (string) --

      The VPC origin ETag.

GetVpcOrigin (updated) Link ¶
Changes (response)
{'VpcOrigin': {'VpcOriginEndpointConfig': {'IpAddressType': 'ipv4 | '
                                                            'dualstack'}}}

Get the details of an Amazon CloudFront VPC origin.

See also: AWS API Documentation

Request Syntax

client.get_vpc_origin(
    Id='string'
)
type Id:

string

param Id:

[REQUIRED]

The VPC origin ID.

rtype:

dict

returns:

Response Syntax

{
    'VpcOrigin': {
        'Id': 'string',
        'Arn': 'string',
        'AccountId': 'string',
        'Status': 'string',
        'CreatedTime': datetime(2015, 1, 1),
        'LastModifiedTime': datetime(2015, 1, 1),
        'VpcOriginEndpointConfig': {
            'Name': 'string',
            'Arn': 'string',
            'HTTPPort': 123,
            'HTTPSPort': 123,
            'OriginProtocolPolicy': 'http-only'|'match-viewer'|'https-only',
            'OriginSslProtocols': {
                'Quantity': 123,
                'Items': [
                    'SSLv3'|'TLSv1'|'TLSv1.1'|'TLSv1.2',
                ]
            },
            'IpAddressType': 'ipv4'|'dualstack'
        }
    },
    'ETag': 'string'
}

Response Structure

  • (dict) --

    • VpcOrigin (dict) --

      The VPC origin.

      • Id (string) --

        The VPC origin ID.

      • Arn (string) --

        The VPC origin ARN.

      • AccountId (string) --

        The account ID of the Amazon Web Services account that owns the VPC origin.

      • Status (string) --

        The VPC origin status.

      • CreatedTime (datetime) --

        The VPC origin created time.

      • LastModifiedTime (datetime) --

        The VPC origin last modified time.

      • VpcOriginEndpointConfig (dict) --

        The VPC origin endpoint configuration.

        • Name (string) --

          The name of the CloudFront VPC origin endpoint configuration.

        • Arn (string) --

          The ARN of the CloudFront VPC origin endpoint configuration.

        • HTTPPort (integer) --

          The HTTP port for the CloudFront VPC origin endpoint configuration. The default value is 80.

        • HTTPSPort (integer) --

          The HTTPS port of the CloudFront VPC origin endpoint configuration. The default value is 443.

        • OriginProtocolPolicy (string) --

          The origin protocol policy for the CloudFront VPC origin endpoint configuration.

        • OriginSslProtocols (dict) --

          A complex type that contains information about the SSL/TLS protocols that CloudFront can use when establishing an HTTPS connection with your origin.

          • Quantity (integer) --

            The number of SSL/TLS protocols that you want to allow CloudFront to use when establishing an HTTPS connection with this origin.

          • Items (list) --

            A list that contains allowed SSL/TLS protocols for this distribution.

            • (string) --

        • IpAddressType (string) --

          The IP address type of the CloudFront VPC origin endpoint configuration. Valid values are ipv4 and dualstack. IPv6-only is not supported for VPC origins.

    • ETag (string) --

      The VPC origin ETag.

ListVpcOrigins (updated) Link ¶
Changes (response)
{'VpcOriginList': {'Items': {'IpAddressType': 'ipv4 | dualstack'}}}

List the CloudFront VPC origins in your account.

See also: AWS API Documentation

Request Syntax

client.list_vpc_origins(
    Marker='string',
    MaxItems='string'
)
type Marker:

string

param Marker:

The marker associated with the VPC origins list.

type MaxItems:

string

param MaxItems:

The maximum number of items included in the list.

rtype:

dict

returns:

Response Syntax

{
    'VpcOriginList': {
        'Marker': 'string',
        'NextMarker': 'string',
        'MaxItems': 123,
        'IsTruncated': True|False,
        'Quantity': 123,
        'Items': [
            {
                'Id': 'string',
                'Name': 'string',
                'Status': 'string',
                'CreatedTime': datetime(2015, 1, 1),
                'LastModifiedTime': datetime(2015, 1, 1),
                'Arn': 'string',
                'AccountId': 'string',
                'OriginEndpointArn': 'string',
                'IpAddressType': 'ipv4'|'dualstack'
            },
        ]
    }
}

Response Structure

  • (dict) --

    • VpcOriginList (dict) --

      List of VPC origins.

      • Marker (string) --

        The marker associated with the VPC origins list.

      • NextMarker (string) --

        The next marker associated with the VPC origins list.

      • MaxItems (integer) --

        The maximum number of items included in the list.

      • IsTruncated (boolean) --

        A flag that indicates whether more VPC origins remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more VPC origins in the list.

      • Quantity (integer) --

        The number of VPC origins in the list.

      • Items (list) --

        The items of the VPC origins list.

        • (dict) --

          A summary of the CloudFront VPC origin.

          • Id (string) --

            The VPC origin summary ID.

          • Name (string) --

            The VPC origin summary name.

          • Status (string) --

            The VPC origin summary status.

          • CreatedTime (datetime) --

            The VPC origin summary created time.

          • LastModifiedTime (datetime) --

            The VPC origin summary last modified time.

          • Arn (string) --

            The VPC origin summary ARN.

          • AccountId (string) --

            The account ID of the Amazon Web Services account that owns the VPC origin.

          • OriginEndpointArn (string) --

            The VPC origin summary origin endpoint ARN.

          • IpAddressType (string) --

            The IP address type of the CloudFront VPC origin. Valid values are ipv4 and dualstack. IPv6-only is not supported for VPC origins.

UpdateVpcOrigin (updated) Link ¶
Changes (request, response)
Request
{'VpcOriginEndpointConfig': {'IpAddressType': 'ipv4 | dualstack'}}
Response
{'VpcOrigin': {'VpcOriginEndpointConfig': {'IpAddressType': 'ipv4 | '
                                                            'dualstack'}}}

Update an Amazon CloudFront VPC origin in your account.

See also: AWS API Documentation

Request Syntax

client.update_vpc_origin(
    VpcOriginEndpointConfig={
        'Name': 'string',
        'Arn': 'string',
        'HTTPPort': 123,
        'HTTPSPort': 123,
        'OriginProtocolPolicy': 'http-only'|'match-viewer'|'https-only',
        'OriginSslProtocols': {
            'Quantity': 123,
            'Items': [
                'SSLv3'|'TLSv1'|'TLSv1.1'|'TLSv1.2',
            ]
        },
        'IpAddressType': 'ipv4'|'dualstack'
    },
    Id='string',
    IfMatch='string'
)
type VpcOriginEndpointConfig:

dict

param VpcOriginEndpointConfig:

[REQUIRED]

The VPC origin endpoint configuration.

  • Name (string) -- [REQUIRED]

    The name of the CloudFront VPC origin endpoint configuration.

  • Arn (string) -- [REQUIRED]

    The ARN of the CloudFront VPC origin endpoint configuration.

  • HTTPPort (integer) -- [REQUIRED]

    The HTTP port for the CloudFront VPC origin endpoint configuration. The default value is 80.

  • HTTPSPort (integer) -- [REQUIRED]

    The HTTPS port of the CloudFront VPC origin endpoint configuration. The default value is 443.

  • OriginProtocolPolicy (string) -- [REQUIRED]

    The origin protocol policy for the CloudFront VPC origin endpoint configuration.

  • OriginSslProtocols (dict) --

    A complex type that contains information about the SSL/TLS protocols that CloudFront can use when establishing an HTTPS connection with your origin.

    • Quantity (integer) -- [REQUIRED]

      The number of SSL/TLS protocols that you want to allow CloudFront to use when establishing an HTTPS connection with this origin.

    • Items (list) -- [REQUIRED]

      A list that contains allowed SSL/TLS protocols for this distribution.

      • (string) --

  • IpAddressType (string) --

    The IP address type of the CloudFront VPC origin endpoint configuration. Valid values are ipv4 and dualstack. IPv6-only is not supported for VPC origins.

type Id:

string

param Id:

[REQUIRED]

The VPC origin ID.

type IfMatch:

string

param IfMatch:

[REQUIRED]

The VPC origin to update, if a match occurs.

rtype:

dict

returns:

Response Syntax

{
    'VpcOrigin': {
        'Id': 'string',
        'Arn': 'string',
        'AccountId': 'string',
        'Status': 'string',
        'CreatedTime': datetime(2015, 1, 1),
        'LastModifiedTime': datetime(2015, 1, 1),
        'VpcOriginEndpointConfig': {
            'Name': 'string',
            'Arn': 'string',
            'HTTPPort': 123,
            'HTTPSPort': 123,
            'OriginProtocolPolicy': 'http-only'|'match-viewer'|'https-only',
            'OriginSslProtocols': {
                'Quantity': 123,
                'Items': [
                    'SSLv3'|'TLSv1'|'TLSv1.1'|'TLSv1.2',
                ]
            },
            'IpAddressType': 'ipv4'|'dualstack'
        }
    },
    'ETag': 'string'
}

Response Structure

  • (dict) --

    • VpcOrigin (dict) --

      The VPC origin.

      • Id (string) --

        The VPC origin ID.

      • Arn (string) --

        The VPC origin ARN.

      • AccountId (string) --

        The account ID of the Amazon Web Services account that owns the VPC origin.

      • Status (string) --

        The VPC origin status.

      • CreatedTime (datetime) --

        The VPC origin created time.

      • LastModifiedTime (datetime) --

        The VPC origin last modified time.

      • VpcOriginEndpointConfig (dict) --

        The VPC origin endpoint configuration.

        • Name (string) --

          The name of the CloudFront VPC origin endpoint configuration.

        • Arn (string) --

          The ARN of the CloudFront VPC origin endpoint configuration.

        • HTTPPort (integer) --

          The HTTP port for the CloudFront VPC origin endpoint configuration. The default value is 80.

        • HTTPSPort (integer) --

          The HTTPS port of the CloudFront VPC origin endpoint configuration. The default value is 443.

        • OriginProtocolPolicy (string) --

          The origin protocol policy for the CloudFront VPC origin endpoint configuration.

        • OriginSslProtocols (dict) --

          A complex type that contains information about the SSL/TLS protocols that CloudFront can use when establishing an HTTPS connection with your origin.

          • Quantity (integer) --

            The number of SSL/TLS protocols that you want to allow CloudFront to use when establishing an HTTPS connection with this origin.

          • Items (list) --

            A list that contains allowed SSL/TLS protocols for this distribution.

            • (string) --

        • IpAddressType (string) --

          The IP address type of the CloudFront VPC origin endpoint configuration. Valid values are ipv4 and dualstack. IPv6-only is not supported for VPC origins.

    • ETag (string) --

      The VPC origin ETag.