Skip to content

Origin

Source code in docs_src/capo_lightsail/types/origin.py
class Origin(TypedDict, closed=True):
    name: NotRequired["capo_lightsail.types.resource_name.ResourceName"]
    """<p>The name of the origin resource.</p>"""
    resource_type: NotRequired["capo_lightsail.types.resource_type.ResourceType"]
    """<p>The resource type of the origin resource (<i>Instance</i>).</p>"""
    region_name: NotRequired["capo_lightsail.types.region_name.RegionName"]
    """<p>The AWS Region name of the origin resource.</p>"""
    protocol_policy: NotRequired[
        "capo_lightsail.types.origin_protocol_policy_enum.OriginProtocolPolicyEnum"
    ]
    """<p>The protocol that your Amazon Lightsail distribution uses when establishing a connection with your origin to pull content.</p>"""
    response_timeout: NotRequired["capo_lightsail.types.integer.integer"]
    """<p>The amount of time, in seconds, that the distribution waits for a response after forwarding a request to the origin. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don't specify otherwise) is 30 seconds.</p>"""
    ip_address_type: NotRequired[
        "capo_lightsail.types.origin_ip_address_type_enum.OriginIpAddressTypeEnum"
    ]
    """<p>The IP address type that the distribution uses when connecting to the origin.</p> <p>The possible values are <code>ipv4</code> for IPv4 only, <code>ipv6</code> for IPv6 only, and <code>dualstack</code> for IPv4 and IPv6.</p>"""
    is_private_origin_access_enabled: NotRequired[
        "capo_lightsail.types.boolean.boolean"
    ]
    """<p>Specifies whether private origin access is enabled for the distribution's origin. With private origin access, the distribution can serve objects that aren't publicly accessible from a Lightsail bucket.</p> <p>This applies when you set the bucket's <code>getObject</code> access rule to <code>private</code>. It also applies when you set <code>getObject</code> to <code>public</code> but set individual objects to private.</p>"""

ip_address_type instance-attribute

ip_address_type: NotRequired[OriginIpAddressTypeEnum]

The IP address type that the distribution uses when connecting to the origin.

The possible values are ipv4 for IPv4 only, ipv6 for IPv6 only, and dualstack for IPv4 and IPv6.

is_private_origin_access_enabled instance-attribute

is_private_origin_access_enabled: NotRequired[boolean]

Specifies whether private origin access is enabled for the distribution's origin. With private origin access, the distribution can serve objects that aren't publicly accessible from a Lightsail bucket.

This applies when you set the bucket's getObject access rule to private. It also applies when you set getObject to public but set individual objects to private.

name instance-attribute

name: NotRequired[ResourceName]

The name of the origin resource.

protocol_policy instance-attribute

protocol_policy: NotRequired[OriginProtocolPolicyEnum]

The protocol that your Amazon Lightsail distribution uses when establishing a connection with your origin to pull content.

region_name instance-attribute

region_name: NotRequired[RegionName]

The AWS Region name of the origin resource.

resource_type instance-attribute

resource_type: NotRequired[ResourceType]

The resource type of the origin resource (Instance).

response_timeout instance-attribute

response_timeout: NotRequired[integer]

The amount of time, in seconds, that the distribution waits for a response after forwarding a request to the origin. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don't specify otherwise) is 30 seconds.