Class: MintPress::Aws::Lightsail::Distribution

Inherits:
Object
  • Object
show all
Includes:
MintLogger, AwsCommon, Mixins::Properties
Defined in:
src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/distribution.rb

Properties (Read/Write)

  • #distribution_name ⇒ [String] (Default Value: Proc.new { self.name })
    'The name of the distribution to update. Use the GetDistributions action to get a list of distribution names that you can specify.'
    Property Attributes
    • create_distribution_prop ⇒ 'distribution_name'
    • read_only ⇒ false
    • source ⇒ "update_distribution"
    • delete_distribution_prop ⇒ 'distribution_name'
    • get_distributions_prop ⇒ 'distribution_name'
    • update_distribution_prop ⇒ 'distribution_name'
    • default ⇒ Proc.new { self.name }
    

28
29
30
31
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/distribution.rb', line 28

property :distribution_name, create_distribution_prop: 'distribution_name', type: [String], read_only: false, source: "update_distribution", description: 'The name of the distribution to update.

Use the GetDistributions action to get a list of distribution names
that you can specify.', delete_distribution_prop: 'distribution_name', get_distributions_prop: 'distribution_name', update_distribution_prop: 'distribution_name', default: Proc.new { self.name }
  • #origin ⇒ [MintPress::Aws::Lightsail::InputOrigin] (Default Value: MintPress::Aws::Lightsail::InputOrigin.new)
    'An object that describes the origin resource for the distribution, such as a Lightsail instance or load balancer. The distribution pulls, caches, and serves content from the origin.'
    Property Attributes
    • create_distribution_prop ⇒ 'origin'
    • default ⇒ MintPress::Aws::Lightsail::InputOrigin.new
    • read_only ⇒ false
    • source ⇒ "update_distribution"
    • update_distribution_prop ⇒ 'origin'
    

32
33
34
35
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/distribution.rb', line 32

property :origin, create_distribution_prop: 'origin', type: [MintPress::Aws::Lightsail::InputOrigin], default: MintPress::Aws::Lightsail::InputOrigin.new, read_only: false, source: "update_distribution", description: 'An object that describes the origin resource for the distribution,
such as a Lightsail instance or load balancer.

The distribution pulls, caches, and serves content from the origin.', update_distribution_prop: 'origin'
  • #default_cache_behavior ⇒ [String]
    'An object that describes the default cache behavior for the distribution.'
    Property Attributes
    • create_distribution_prop ⇒ "default_cache_behavior.behavior"
    • read_only ⇒ false
    • source ⇒ "update_distribution"
    • update_distribution_prop ⇒ "default_cache_behavior.behavior"
    

36
37
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/distribution.rb', line 36

property :default_cache_behavior, create_distribution_prop: "default_cache_behavior.behavior", type: [String], read_only: false, source: "update_distribution", description: 'An object that describes the default cache behavior for the
distribution.', update_distribution_prop: "default_cache_behavior.behavior"
  • #cache_behavior_settings ⇒ [MintPress::Aws::Lightsail::CacheSetting] (Default Value: MintPress::Aws::Lightsail::CacheSetting.new)
    'An object that describes the cache behavior settings for the distribution. The cacheBehaviorSettings specified in your UpdateDistributionRequest will replace your distribution"s existing settings.'
    Property Attributes
    • create_distribution_prop ⇒ 'cache_behavior_settings'
    • default ⇒ MintPress::Aws::Lightsail::CacheSetting.new
    • read_only ⇒ false
    • source ⇒ "update_distribution"
    • update_distribution_prop ⇒ 'cache_behavior_settings'
    

38
39
40
41
42
43
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/distribution.rb', line 38

property :cache_behavior_settings, create_distribution_prop: 'cache_behavior_settings', type: [MintPress::Aws::Lightsail::CacheSetting], default: MintPress::Aws::Lightsail::CacheSetting.new, read_only: false, source: "update_distribution", description: 'An object that describes the cache behavior settings for the
distribution.

 The cacheBehaviorSettings specified in your
UpdateDistributionRequest will replace your distribution"s existing
settings.', update_distribution_prop: 'cache_behavior_settings'
  • #cache_behaviors ⇒ Array of ⇒ [MintPress::Aws::Lightsail::CacheBehaviorPerPath]
    'An array of objects that describe the per-path cache behavior for the distribution.'
    Property Attributes
    • create_distribution_prop ⇒ 'cache_behaviors'
    • read_only ⇒ false
    • source ⇒ "update_distribution"
    • update_distribution_prop ⇒ 'cache_behaviors'
    

44
45
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/distribution.rb', line 44

property :cache_behaviors, create_distribution_prop: 'cache_behaviors', type: [MintPress::Aws::Lightsail::CacheBehaviorPerPath], array: true, read_only: false, source: "update_distribution", description: 'An array of objects that describe the per-path cache behavior for the
distribution.', update_distribution_prop: 'cache_behaviors'
  • #tags ⇒ Hash of ⇒ [MintPress::Aws::Lightsail::Tag]
    'The tag keys and optional values to add to the distribution during create. Use the TagResource action to tag a resource after it"s created.'
    Property Attributes
    • create_distribution_prop ⇒ 'tags'
    • read_only ⇒ false
    • source ⇒ "create_distribution"
    

46
47
48
49
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/distribution.rb', line 46

property :tags, create_distribution_prop: 'tags', type: [MintPress::Aws::Lightsail::Tag], array: false, read_only: false, source: "create_distribution", description: 'The tag keys and optional values to add to the distribution during
create.

Use the TagResource action to tag a resource after it"s created.', hash: true
  • #page_token ⇒ [String]
    'The token to advance to the next page of results from your request. To get a page token, perform an initial GetDistributions request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.'
    Property Attributes
    • get_distributions_prop ⇒ 'page_token'
    • read_only ⇒ false
    • source ⇒ "get_distributions"
    

50
51
52
53
54
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/distribution.rb', line 50

property :page_token, get_distributions_prop: 'page_token', type: [String], read_only: false, source: "get_distributions", description: 'The token to advance to the next page of results from your request.

To get a page token, perform an initial GetDistributions request. If
your results are paginated, the response will return a next page token
that you can specify as the page token in a subsequent request.'
  • #is_enabled ⇒ [TrueClass,FalseClass]
    'Indicates whether to enable the distribution.'
    Property Attributes
    • update_distribution_prop ⇒ 'is_enabled'
    • read_only ⇒ false
    • source ⇒ "update_distribution"
    

55
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/distribution.rb', line 55

property :is_enabled, update_distribution_prop: 'is_enabled', type: [TrueClass,FalseClass], read_only: false, source: "update_distribution", description: 'Indicates whether to enable the distribution.'
  • #bundle ⇒ [MintPress::Aws::Lightsail::Bundle]
    'The bundle ID to use for the distribution. A distribution bundle describes the specifications of your distribution, such as the monthly cost and monthly network transfer quota. Use the GetDistributionBundles action to get a list of distribution bundle IDs that you can specify.'
    Property Attributes
    • create_distribution_prop ⇒ 'bundle_id'
    • read_only ⇒ false
    • source ⇒ "create_distribution"
    • from ⇒ String
    

56
57
58
59
60
61
62
63
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/distribution.rb', line 56

property :bundle, create_distribution_prop: 'bundle_id', type: [MintPress::Aws::Lightsail::Bundle], read_only: false, source: "create_distribution", description: 'The bundle ID to use for the distribution.

A distribution bundle describes the specifications of your
distribution, such as the monthly cost and monthly network transfer
quota.

Use the GetDistributionBundles action to get a list of distribution
bundle IDs that you can specify.', from: String
  • #name ⇒ [String]

    Property Attributes 
    

64
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/distribution.rb', line 64

property :name, type: [String]
  • #region ⇒ String
    Region _specifically for this object_. If you're not doing different objects in different regions, you should not set this, but rather set the region on your AwsPlatformProvider instead
    Property Attributes 
    

68
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/distribution.rb', line 68

property :region, type: String
  • #platform ⇒ MintPress::InfrastructureAws::AwsPlatform (Default Value: MintPress::InfrastructureAws::AwsPlatform.new)
    The platform details, including credentials - normally this will come via AwsPlatformProvider (see the Infrastructure Providers section of the documentation)
    Property Attributes
    • default ⇒ MintPress::InfrastructureAws::AwsPlatform.new
    

71
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/distribution.rb', line 71

property :platform, type: MintPress::InfrastructureAws::AwsPlatform, default: MintPress::InfrastructureAws::AwsPlatform.new

Properties (Read Only)

Constant Summary

Constants included from MintLogger

MintLogger::DEBUG, MintLogger::ERROR, MintLogger::FATAL, MintLogger::INFO, MintLogger::UNKNOWN, MintLogger::VERBOSE, MintLogger::WARN

Instance Attribute Summary

Attributes included from Mixins::Properties

#autopush_set_cache, #dynamic_create, #harvest_on_access, #harvest_undefined_only, #harvested, #tree_root

Instance Method Summary collapse

Methods included from AwsCommon

#alive?, all, #attach_generic, #attached?, #available?, #build_create_hash, #by_id, #by_name, #create_generic, #delete_cascade_generic, #delete_generic, #detach_generic, #exists?, #fill_in_details, #find_by_details, #find_global_object, #get_aws_region, #get_state, #handle_singleton_object, #harvest, #perform_operation, #prop_to_hash, #register_aws_object, #resource_api, #running?, #start_generic, #started?, #stop_generic, #terminate_generic

Methods included from Mixins::Properties

#[], #[]=, #add_validate_report_result, #armour_set_property, #array_contains?, #array_is_a?, #check_autopush, #check_stack_overflow, #clone_property_object, #cloner_handle_single_property, #coerce_single, #contains_as_string?, #display_validate_report_result, #double_initialize?, #dump_to_hash, #find_parent, #find_parent_by_identity, #generate_accessor_functions, #get_canonical_renamed, #get_from_opts, #get_my_name, #get_property, #get_property_item, #has?, included, #initialize_validate_report, #inspect, #is_cloned_object?, #is_mintpress_object?, #is_probably_canonical?, #is_set?, #local_debug, #local_info, #local_verbose, #mintpress_property_definitions, #place_object_by_identity, #process_properties, #prop_set?, #property, #property_definitions, #property_details, #property_is_simple_object?, #push_root!, #require_property, #require_update, #retrieve_docstring, #sanitize, #set_map_dirty, #set_property, #set_property_item, #show_short_array, #strip_defaults!, #synchronize, #uncloned_property_definitions, #update_map, #validate, #validate_generic, #validate_properties, #validate_property, #validate_required, #version_allowed?, #weakref

Methods included from MintLogger::Utils::Common

#boolean_val, #has_value?, #no_value?, #nvl, #path_as_symbol, #ruby_level_to_send

Constructor Details

#initialize(opts = {}) ⇒ Distribution

Returns a new instance of Distribution.

Instance Method Details

#create ⇒ Object

#delete ⇒ Object

#delete_cascade ⇒ Object

#get ⇒ Object

#update ⇒ Object