CloudFront / Client / create_vpc_origin

create_vpc_origin#

CloudFront.Client.create_vpc_origin(**kwargs)#

Create an Amazon CloudFront VPC origin.

See also: AWS API Documentation

Request Syntax

response = 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',
            ]
        }
    },
    Tags={
        'Items': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
)
Parameters:
  • VpcOriginEndpointConfig (dict) –

    [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.

    • HTTPSPort (integer) – [REQUIRED]

      The HTTPS port of the CloudFront VPC origin endpoint configuration.

    • 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) –

  • Tags (dict) –

    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 _ - . : / = + @.

Return type:

dict

Returns:

Response Syntax

{
    'VpcOrigin': {
        'Id': 'string',
        'Arn': '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',
                ]
            }
        }
    },
    'Location': 'string',
    'ETag': 'string'
}

Response Structure

  • (dict) –

    • VpcOrigin (dict) –

      The VPC origin.

      • Id (string) –

        The VPC origin ID.

      • Arn (string) –

        The VPC origin ARN.

      • 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.

        • HTTPSPort (integer) –

          The HTTPS port of the CloudFront VPC origin endpoint configuration.

        • 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) –

    • Location (string) –

      The VPC origin location.

    • ETag (string) –

      The VPC origin ETag.

Exceptions

  • CloudFront.Client.exceptions.AccessDenied

  • CloudFront.Client.exceptions.UnsupportedOperation

  • CloudFront.Client.exceptions.InconsistentQuantities

  • CloudFront.Client.exceptions.EntityAlreadyExists

  • CloudFront.Client.exceptions.InvalidTagging

  • CloudFront.Client.exceptions.InvalidArgument

  • CloudFront.Client.exceptions.EntityLimitExceeded