Class: Aws::Lightsail::Types::Origin

Inherits:

Struct

• Object
• Struct
• Aws::Lightsail::Types::Origin

Defined in:

gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb

Overview

Describes the origin resource of an Amazon Lightsail content delivery network (CDN) distribution.

An origin can be a Lightsail instance, bucket, or load balancer. A distribution pulls content from an origin, caches it, and serves it to viewers via a worldwide network of edge servers.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #ip_address_type ⇒ String

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

• #is_private_origin_access_enabled ⇒ Boolean

  Specifies whether private origin access is enabled for the distribution's origin.

• #name ⇒ String

  The name of the origin resource.

• #protocol_policy ⇒ String

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

• #region_name ⇒ String

  The AWS Region name of the origin resource.

• #resource_type ⇒ String

  The resource type of the origin resource (Instance).

• #response_timeout ⇒ Integer

  The amount of time, in seconds, that the distribution waits for a response after forwarding a request to the origin.

Instance Attribute Details

#ip_address_type ⇒ String

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.

Returns:

• (String)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 12336

class Origin < Struct.new(
  :name,
  :resource_type,
  :region_name,
  :protocol_policy,
  :response_timeout,
  :ip_address_type,
  :is_private_origin_access_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#is_private_origin_access_enabled ⇒ 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.

Returns:

• (Boolean)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 12336

class Origin < Struct.new(
  :name,
  :resource_type,
  :region_name,
  :protocol_policy,
  :response_timeout,
  :ip_address_type,
  :is_private_origin_access_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the origin resource.

Returns:

• (String)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 12336

class Origin < Struct.new(
  :name,
  :resource_type,
  :region_name,
  :protocol_policy,
  :response_timeout,
  :ip_address_type,
  :is_private_origin_access_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#protocol_policy ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 12336

class Origin < Struct.new(
  :name,
  :resource_type,
  :region_name,
  :protocol_policy,
  :response_timeout,
  :ip_address_type,
  :is_private_origin_access_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#region_name ⇒ String

The AWS Region name of the origin resource.

Returns:

• (String)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 12336

class Origin < Struct.new(
  :name,
  :resource_type,
  :region_name,
  :protocol_policy,
  :response_timeout,
  :ip_address_type,
  :is_private_origin_access_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#resource_type ⇒ String

The resource type of the origin resource (Instance).

Returns:

• (String)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 12336

class Origin < Struct.new(
  :name,
  :resource_type,
  :region_name,
  :protocol_policy,
  :response_timeout,
  :ip_address_type,
  :is_private_origin_access_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#response_timeout ⇒ 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.

Returns:

• (Integer)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 12336

class Origin < Struct.new(
  :name,
  :resource_type,
  :region_name,
  :protocol_policy,
  :response_timeout,
  :ip_address_type,
  :is_private_origin_access_enabled)
  SENSITIVE = []
  include Aws::Structure
end