Class: MintPress::Aws::Lightsail::ContainerService

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

Properties (Read/Write)

  • #arn ⇒ [String]
    'The Amazon Resource Name (ARN) of the container service.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::ContainerService"
    • orig_name ⇒ 'arn'
    

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

property :arn, disposition: :attribute, description: 'The Amazon Resource Name (ARN) of the container service.', source: "MintPress::Aws::Lightsail::ContainerService", orig_name: 'arn', type: [String]
  • #container_service_name ⇒ [String]
    'The name of the container service.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::ContainerService"
    • orig_name ⇒ 'container_service_name'
    

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

property :container_service_name, disposition: :attribute, description: 'The name of the container service.', source: "MintPress::Aws::Lightsail::ContainerService", orig_name: 'container_service_name', type: [String]
  • #created_at ⇒ [Time]
    'The timestamp when the container service was created.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::ContainerService"
    • orig_name ⇒ 'created_at'
    

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

property :created_at, disposition: :attribute, description: 'The timestamp when the container service was created.', source: "MintPress::Aws::Lightsail::ContainerService", orig_name: 'created_at', type: [Time]
  • #current_deployment ⇒ [MintPress::Aws::Lightsail::ContainerServiceDeployment] (Default Value: MintPress::Aws::Lightsail::ContainerServiceDeployment.new)
    'An object that describes the current container deployment of the container service.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::ContainerService"
    • orig_name ⇒ 'current_deployment'
    • default ⇒ MintPress::Aws::Lightsail::ContainerServiceDeployment.new
    

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

property :current_deployment, disposition: :attribute, description: 'An object that describes the current container deployment of the container service.', source: "MintPress::Aws::Lightsail::ContainerService", orig_name: 'current_deployment', type: [MintPress::Aws::Lightsail::ContainerServiceDeployment], default: MintPress::Aws::Lightsail::ContainerServiceDeployment.new
  • #is_disabled ⇒ [TrueClass,FalseClass]
    'A Boolean value to indicate whether the container service is disabled.'
    Property Attributes
    • source ⇒ "update_container_service"
    • orig_name ⇒ 'is_disabled'
    • update_container_service_prop ⇒ 'is_disabled'
    • read_only ⇒ false
    

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

property :is_disabled, description: 'A Boolean value to indicate whether the container service is disabled.', source: "update_container_service", orig_name: 'is_disabled', type: [TrueClass,FalseClass], update_container_service_prop: 'is_disabled', read_only: false
  • #location ⇒ [MintPress::Aws::Lightsail::ResourceLocation] (Default Value: MintPress::Aws::Lightsail::ResourceLocation.new)
    'An object that describes the location of the container service, such as the AWS Region and Availability Zone.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::ContainerService"
    • orig_name ⇒ 'location'
    • default ⇒ MintPress::Aws::Lightsail::ResourceLocation.new
    

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

property :location, disposition: :attribute, description: 'An object that describes the location of the container service, such as the AWS Region and Availability Zone.', source: "MintPress::Aws::Lightsail::ContainerService", orig_name: 'location', type: [MintPress::Aws::Lightsail::ResourceLocation], default: MintPress::Aws::Lightsail::ResourceLocation.new
  • #next_deployment ⇒ [MintPress::Aws::Lightsail::ContainerServiceDeployment] (Default Value: MintPress::Aws::Lightsail::ContainerServiceDeployment.new)
    'An object that describes the next deployment of the container service.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::ContainerService"
    • orig_name ⇒ 'next_deployment'
    • default ⇒ MintPress::Aws::Lightsail::ContainerServiceDeployment.new
    

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

property :next_deployment, disposition: :attribute, description: 'An object that describes the next deployment of the container service.', source: "MintPress::Aws::Lightsail::ContainerService", orig_name: 'next_deployment', type: [MintPress::Aws::Lightsail::ContainerServiceDeployment], default: MintPress::Aws::Lightsail::ContainerServiceDeployment.new
  • #power ⇒ [String]
    'The power for the container service. The power specifies the amount of memory, vCPUs, and base monthly cost of each node of the container service. The power and scale of a container service makes up its configured capacity. To determine the monthly price of your container service, multiply the base price of the power with the scale (the number of nodes) of the service. Use the GetContainerServicePowers action to view the specifications of each power option.'
    Property Attributes
    • source ⇒ "update_container_service"
    • orig_name ⇒ 'power'
    • create_container_service_prop ⇒ 'power'
    • read_only ⇒ false
    • update_container_service_prop ⇒ 'power'
    • from ⇒ String
    

35
36
37
38
39
40
41
42
43
44
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/container_service.rb', line 35

property :power, description: 'The power for the container service.

The power specifies the amount of memory, vCPUs, and base monthly cost
of each node of the container service. The power and scale of a
container service makes up its configured capacity. To determine the
monthly price of your container service, multiply the base price of
the power with the scale (the number of nodes) of the service.

Use the GetContainerServicePowers action to view the specifications
of each power option.', source: "update_container_service", orig_name: 'power', type: [String], create_container_service_prop: 'power', read_only: false, update_container_service_prop: 'power', from: String
  • #principal_arn ⇒ [String]
    'The principal ARN of the container service.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::ContainerService"
    • orig_name ⇒ 'principal_arn'
    

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

property :principal_arn, disposition: :attribute, description: 'The principal ARN of the container service.', source: "MintPress::Aws::Lightsail::ContainerService", orig_name: 'principal_arn', type: [String]
  • #private_domain_name ⇒ [String]
    'The private domain name of the container service.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::ContainerService"
    • orig_name ⇒ 'private_domain_name'
    

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

property :private_domain_name, disposition: :attribute, description: 'The private domain name of the container service.', source: "MintPress::Aws::Lightsail::ContainerService", orig_name: 'private_domain_name', type: [String]
  • #public_domain_names ⇒ Array of ⇒ []
    'The public domain names to use with the container service, such as example.com and www.example.com. You can specify up to four public domain names for a container service. The domain names that you specify are used when you create a deployment with a container configured as the public endpoint of your container service. If you don"t specify public domain names, then you can use the default domain of the container service. You must create and validate an SSL/TLS certificate before you can use public domain names with your container service. Use the CreateCertificate action to create a certificate for the public domain names you want to use with your container service. You can specify public domain names using a string to array map as shown in the example later on this page.'
    Property Attributes
    • source ⇒ "update_container_service"
    • orig_name ⇒ 'public_domain_names'
    • create_container_service_prop ⇒ 'public_domain_names'
    • read_only ⇒ false
    • update_container_service_prop ⇒ 'public_domain_names'
    

47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/container_service.rb', line 47

property :public_domain_names, description: 'The public domain names to use with the container service, such as
example.com and www.example.com.

You can specify up to four public domain names for a container
service. The domain names that you specify are used when you create a
deployment with a container configured as the public endpoint of your
container service.

If you don"t specify public domain names, then you can use the
default domain of the container service.

You must create and validate an SSL/TLS certificate before you can use
public domain names with your container service. Use the
CreateCertificate action to create a certificate for the public
domain names you want to use with your container service.

You can specify public domain names using a string to array map as
shown in the example later on this page.', source: "update_container_service", orig_name: 'public_domain_names', type: [], array: true, create_container_service_prop: 'public_domain_names', read_only: false, update_container_service_prop: 'public_domain_names'
  • #resource_type ⇒ [String]
    'The Lightsail resource type of the container service (i.e., ContainerService).'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::ContainerService"
    • orig_name ⇒ 'resource_type'
    

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

property :resource_type, disposition: :attribute, description: 'The Lightsail resource type of the container service (i.e., ContainerService).', source: "MintPress::Aws::Lightsail::ContainerService", orig_name: 'resource_type', type: [String]
  • #scale ⇒ [Integer]
    'The scale for the container service. The scale specifies the allocated compute nodes of the container service. The power and scale of a container service makes up its configured capacity. To determine the monthly price of your container service, multiply the base price of the power with the scale (the number of nodes) of the service.'
    Property Attributes
    • source ⇒ "update_container_service"
    • orig_name ⇒ 'scale'
    • create_container_service_prop ⇒ 'scale'
    • read_only ⇒ false
    • update_container_service_prop ⇒ 'scale'
    

66
67
68
69
70
71
72
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/container_service.rb', line 66

property :scale, description: 'The scale for the container service.

The scale specifies the allocated compute nodes of the container
service. The power and scale of a container service makes up its
configured capacity. To determine the monthly price of your container
service, multiply the base price of the power with the scale (the
number of nodes) of the service.', source: "update_container_service", orig_name: 'scale', type: [Integer], create_container_service_prop: 'scale', read_only: false, update_container_service_prop: 'scale'
  • #state ⇒ [String]
    'The current state of the container service.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::ContainerService"
    • orig_name ⇒ 'state'
    

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

property :state, disposition: :attribute, description: 'The current state of the container service.', source: "MintPress::Aws::Lightsail::ContainerService", orig_name: 'state', type: [String]
  • #tags ⇒ Hash of ⇒ [MintPress::Aws::Lightsail::Tag]
    'The tag keys and optional values for the resource.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::ContainerService"
    • orig_name ⇒ 'tags'
    • create_container_service_prop ⇒ 'tags'
    • read_only ⇒ false
    

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

property :tags, disposition: :attribute, description: 'The tag keys and optional values for the resource.', source: "MintPress::Aws::Lightsail::ContainerService", orig_name: 'tags', type: [MintPress::Aws::Lightsail::Tag], array: false, create_container_service_prop: 'tags', read_only: false, hash: true
  • #url ⇒ [String]
    'The publicly accessible URL of the container service.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::ContainerService"
    • orig_name ⇒ 'url'
    

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

property :url, disposition: :attribute, description: 'The publicly accessible URL of the container service.', source: "MintPress::Aws::Lightsail::ContainerService", orig_name: 'url', type: [String]
  • #service_name ⇒ [String]
    'The name of the container service to update.'
    Property Attributes
    • create_container_service_prop ⇒ 'service_name'
    • read_only ⇒ false
    • source ⇒ "update_container_service"
    • delete_container_service_prop ⇒ 'service_name'
    • get_container_services_prop ⇒ 'service_name'
    • update_container_service_prop ⇒ 'service_name'
    

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

property :service_name, create_container_service_prop: 'service_name', type: [String], read_only: false, source: "update_container_service", description: 'The name of the container service to update.', delete_container_service_prop: 'service_name', get_container_services_prop: 'service_name', update_container_service_prop: 'service_name'
  • #deployment ⇒ [MintPress::Aws::Lightsail::ContainerServiceDeployment] (Default Value: MintPress::Aws::Lightsail::ContainerServiceDeployment.new)
    'An object that describes a deployment for the container service. A deployment specifies the containers that will be launched on the container service and their settings, such as the ports to open, the environment variables to apply, and the launch command to run. It also specifies the container that will serve as the public endpoint of the deployment and its settings, such as the HTTP or HTTPS port to use, and the health check configuration.'
    Property Attributes
    • create_container_service_prop ⇒ 'deployment'
    • default ⇒ MintPress::Aws::Lightsail::ContainerServiceDeployment.new
    • read_only ⇒ false
    • source ⇒ "create_container_service"
    

77
78
79
80
81
82
83
84
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/container_service.rb', line 77

property :deployment, create_container_service_prop: 'deployment', type: [MintPress::Aws::Lightsail::ContainerServiceDeployment], default: MintPress::Aws::Lightsail::ContainerServiceDeployment.new, read_only: false, source: "create_container_service", description: 'An object that describes a deployment for the container service.

A deployment specifies the containers that will be launched on the
container service and their settings, such as the ports to open, the
environment variables to apply, and the launch command to run. It also
specifies the container that will serve as the public endpoint of the
deployment and its settings, such as the HTTP or HTTPS port to use,
and the health check configuration.'
  • #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 
    

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

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
    

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

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 = {}) ⇒ ContainerService

Returns a new instance of ContainerService.

Instance Method Details

#create ⇒ Object

#delete ⇒ Object

#delete_cascade ⇒ Object

#get ⇒ Object

#update ⇒ Object