# frozen_string_literal: true # WARNING ABOUT GENERATED CODE # # This file is generated. See the contributing guide for more information: # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md # # WARNING ABOUT GENERATED CODE module Aws::Lightsail module Types # Lightsail throws this exception when the user cannot be authenticated # or uses invalid credentials to access a resource. # # @!attribute [rw] code # @return [String] # # @!attribute [rw] docs # @return [String] # # @!attribute [rw] message # @return [String] # # @!attribute [rw] tip # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/AccessDeniedException AWS API Documentation # class AccessDeniedException < Struct.new( :code, :docs, :message, :tip) SENSITIVE = [] include Aws::Structure end # Describes an access key for an Amazon Lightsail bucket. # # Access keys grant full programmatic access to the specified bucket and # its objects. You can have a maximum of two access keys per bucket. Use # the CreateBucketAccessKey action to create an access key for a # specific bucket. For more information about access keys, see [Creating # access keys for a bucket in Amazon Lightsail][1] in the *Amazon # Lightsail Developer Guide*. # # The `secretAccessKey` value is returned only in response to the # `CreateBucketAccessKey` action. You can get a secret access key only # when you first create an access key; you cannot get the secret access # key later. If you lose the secret access key, you must create a new # access key. # # # # [1]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-creating-bucket-access-keys # # @!attribute [rw] access_key_id # The ID of the access key. # @return [String] # # @!attribute [rw] secret_access_key # The secret access key used to sign requests. # # You should store the secret access key in a safe location. We # recommend that you delete the access key if the secret access key is # compromised. # @return [String] # # @!attribute [rw] status # The status of the access key. # # A status of `Active` means that the key is valid, while `Inactive` # means it is not. # @return [String] # # @!attribute [rw] created_at # The timestamp when the access key was created. # @return [Time] # # @!attribute [rw] last_used # An object that describes the last time the access key was used. # # This object does not include data in the response of a # CreateBucketAccessKey action. If the access key has not been used, # the `region` and `serviceName` values are `N/A`, and the # `lastUsedDate` value is null. # # # @return [Types::AccessKeyLastUsed] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/AccessKey AWS API Documentation # class AccessKey < Struct.new( :access_key_id, :secret_access_key, :status, :created_at, :last_used) SENSITIVE = [:access_key_id] include Aws::Structure end # Describes the last time an access key was used. # # This object does not include data in the response of a # CreateBucketAccessKey action. # # # # @!attribute [rw] last_used_date # The date and time when the access key was most recently used. # # This value is null if the access key has not been used. # @return [Time] # # @!attribute [rw] region # The AWS Region where this access key was most recently used. # # This value is `N/A` if the access key has not been used. # @return [String] # # @!attribute [rw] service_name # The name of the AWS service with which this access key was most # recently used. # # This value is `N/A` if the access key has not been used. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/AccessKeyLastUsed AWS API Documentation # class AccessKeyLastUsed < Struct.new( :last_used_date, :region, :service_name) SENSITIVE = [] include Aws::Structure end # Describes the anonymous access permissions for an Amazon Lightsail # bucket and its objects. # # For more information about bucket access permissions, see # [Understanding bucket permissions in Amazon Lightsail][1] in the # # *Amazon Lightsail Developer Guide*. # # # # [1]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-understanding-bucket-permissions # # @note When making an API call, you may pass AccessRules # data as a hash: # # { # get_object: "public", # accepts public, private # allow_public_overrides: false, # } # # @!attribute [rw] get_object # Specifies the anonymous access to all objects in a bucket. # # The following options can be specified: # # * `public` - Sets all objects in the bucket to public (read-only), # making them readable by anyone in the world. # # If the `getObject` value is set to `public`, then all objects in # the bucket default to public regardless of the # `allowPublicOverrides` value. # # * `private` - Sets all objects in the bucket to private, making them # readable only by you or anyone you give access to. # # If the `getObject` value is set to `private`, and the # `allowPublicOverrides` value is set to `true`, then all objects in # the bucket default to private unless they are configured with a # `public-read` ACL. Individual objects with a `public-read` ACL are # readable by anyone in the world. # @return [String] # # @!attribute [rw] allow_public_overrides # A Boolean value that indicates whether the access control list (ACL) # permissions that are applied to individual objects override the # `getObject` option that is currently specified. # # When this is true, you can use the [PutObjectAcl][1] Amazon S3 API # action to set individual objects to public (read-only) using the # `public-read` ACL, or to private using the `private` ACL. # # # # [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObjectAcl.html # @return [Boolean] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/AccessRules AWS API Documentation # class AccessRules < Struct.new( :get_object, :allow_public_overrides) SENSITIVE = [] include Aws::Structure end # Lightsail throws this exception when an account is still in the setup # in progress state. # # @!attribute [rw] code # @return [String] # # @!attribute [rw] docs # @return [String] # # @!attribute [rw] message # @return [String] # # @!attribute [rw] tip # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/AccountSetupInProgressException AWS API Documentation # class AccountSetupInProgressException < Struct.new( :code, :docs, :message, :tip) SENSITIVE = [] include Aws::Structure end # Describes an add-on that is enabled for an Amazon Lightsail resource. # # @!attribute [rw] name # The name of the add-on. # @return [String] # # @!attribute [rw] status # The status of the add-on. # @return [String] # # @!attribute [rw] snapshot_time_of_day # The daily time when an automatic snapshot is created. # # The time shown is in `HH:00` format, and in Coordinated Universal # Time (UTC). # # The snapshot is automatically created between the time shown and up # to 45 minutes after. # @return [String] # # @!attribute [rw] next_snapshot_time_of_day # The next daily time an automatic snapshot will be created. # # The time shown is in `HH:00` format, and in Coordinated Universal # Time (UTC). # # The snapshot is automatically created between the time shown and up # to 45 minutes after. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/AddOn AWS API Documentation # class AddOn < Struct.new( :name, :status, :snapshot_time_of_day, :next_snapshot_time_of_day) SENSITIVE = [] include Aws::Structure end # Describes a request to enable, modify, or disable an add-on for an # Amazon Lightsail resource. # # An additional cost may be associated with enabling add-ons. For more # information, see the [Lightsail pricing page][1]. # # # # # # [1]: https://aws.amazon.com/lightsail/pricing/ # # @note When making an API call, you may pass AddOnRequest # data as a hash: # # { # add_on_type: "AutoSnapshot", # required, accepts AutoSnapshot # auto_snapshot_add_on_request: { # snapshot_time_of_day: "TimeOfDay", # }, # } # # @!attribute [rw] add_on_type # The add-on type. # @return [String] # # @!attribute [rw] auto_snapshot_add_on_request # An object that represents additional parameters when enabling or # modifying the automatic snapshot add-on. # @return [Types::AutoSnapshotAddOnRequest] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/AddOnRequest AWS API Documentation # class AddOnRequest < Struct.new( :add_on_type, :auto_snapshot_add_on_request) SENSITIVE = [] include Aws::Structure end # Describes an alarm. # # An alarm is a way to monitor your Lightsail resource metrics. For more # information, see [Alarms in Amazon Lightsail][1]. # # # # [1]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-alarms # # @!attribute [rw] name # The name of the alarm. # @return [String] # # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the alarm. # @return [String] # # @!attribute [rw] created_at # The timestamp when the alarm was created. # @return [Time] # # @!attribute [rw] location # An object that lists information about the location of the alarm. # @return [Types::ResourceLocation] # # @!attribute [rw] resource_type # The Lightsail resource type (e.g., `Alarm`). # @return [String] # # @!attribute [rw] support_code # The support code. Include this code in your email to support when # you have questions about your Lightsail alarm. This code enables our # support team to look up your Lightsail information more easily. # @return [String] # # @!attribute [rw] monitored_resource_info # An object that lists information about the resource monitored by the # alarm. # @return [Types::MonitoredResourceInfo] # # @!attribute [rw] comparison_operator # The arithmetic operation used when comparing the specified statistic # and threshold. # @return [String] # # @!attribute [rw] evaluation_periods # The number of periods over which data is compared to the specified # threshold. # @return [Integer] # # @!attribute [rw] period # The period, in seconds, over which the statistic is applied. # @return [Integer] # # @!attribute [rw] threshold # The value against which the specified statistic is compared. # @return [Float] # # @!attribute [rw] datapoints_to_alarm # The number of data points that must not within the specified # threshold to trigger the alarm. # @return [Integer] # # @!attribute [rw] treat_missing_data # Specifies how the alarm handles missing data points. # # An alarm can treat missing data in the following ways: # # * `breaching` - Assume the missing data is not within the threshold. # Missing data counts towards the number of times the metric is not # within the threshold. # # * `notBreaching` - Assume the missing data is within the threshold. # Missing data does not count towards the number of times the metric # is not within the threshold. # # * `ignore` - Ignore the missing data. Maintains the current alarm # state. # # * `missing` - Missing data is treated as missing. # @return [String] # # @!attribute [rw] statistic # The statistic for the metric associated with the alarm. # # The following statistics are available: # # * `Minimum` - The lowest value observed during the specified period. # Use this value to determine low volumes of activity for your # application. # # * `Maximum` - The highest value observed during the specified # period. Use this value to determine high volumes of activity for # your application. # # * `Sum` - All values submitted for the matching metric added # together. You can use this statistic to determine the total volume # of a metric. # # * `Average` - The value of Sum / SampleCount during the specified # period. By comparing this statistic with the Minimum and Maximum # values, you can determine the full scope of a metric and how close # the average use is to the Minimum and Maximum values. This # comparison helps you to know when to increase or decrease your # resources. # # * `SampleCount` - The count, or number, of data points used for the # statistical calculation. # @return [String] # # @!attribute [rw] metric_name # The name of the metric associated with the alarm. # @return [String] # # @!attribute [rw] state # The current state of the alarm. # # An alarm has the following possible states: # # * `ALARM` - The metric is outside of the defined threshold. # # * `INSUFFICIENT_DATA` - The alarm has just started, the metric is # not available, or not enough data is available for the metric to # determine the alarm state. # # * `OK` - The metric is within the defined threshold. # @return [String] # # @!attribute [rw] unit # The unit of the metric associated with the alarm. # @return [String] # # @!attribute [rw] contact_protocols # The contact protocols for the alarm, such as `Email`, `SMS` (text # messaging), or both. # @return [Array] # # @!attribute [rw] notification_triggers # The alarm states that trigger a notification. # @return [Array] # # @!attribute [rw] notification_enabled # Indicates whether the alarm is enabled. # @return [Boolean] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/Alarm AWS API Documentation # class Alarm < Struct.new( :name, :arn, :created_at, :location, :resource_type, :support_code, :monitored_resource_info, :comparison_operator, :evaluation_periods, :period, :threshold, :datapoints_to_alarm, :treat_missing_data, :statistic, :metric_name, :state, :unit, :contact_protocols, :notification_triggers, :notification_enabled) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass AllocateStaticIpRequest # data as a hash: # # { # static_ip_name: "ResourceName", # required # } # # @!attribute [rw] static_ip_name # The name of the static IP address. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/AllocateStaticIpRequest AWS API Documentation # class AllocateStaticIpRequest < Struct.new( :static_ip_name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] operations # An array of objects that describe the result of the action, such as # the status of the request, the timestamp of the request, and the # resources affected by the request. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/AllocateStaticIpResult AWS API Documentation # class AllocateStaticIpResult < Struct.new( :operations) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass AttachCertificateToDistributionRequest # data as a hash: # # { # distribution_name: "ResourceName", # required # certificate_name: "ResourceName", # required # } # # @!attribute [rw] distribution_name # The name of the distribution that the certificate will be attached # to. # # Use the `GetDistributions` action to get a list of distribution # names that you can specify. # @return [String] # # @!attribute [rw] certificate_name # The name of the certificate to attach to a distribution. # # Only certificates with a status of `ISSUED` can be attached to a # distribution. # # Use the `GetCertificates` action to get a list of certificate names # that you can specify. # # This is the name of the certificate resource type and is used only # to reference the certificate in other API actions. It can be # different than the domain name of the certificate. For example, your # certificate name might be `WordPress-Blog-Certificate` and the # domain name of the certificate might be `example.com`. # # # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/AttachCertificateToDistributionRequest AWS API Documentation # class AttachCertificateToDistributionRequest < Struct.new( :distribution_name, :certificate_name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] operation # An object that describes the result of the action, such as the # status of the request, the timestamp of the request, and the # resources affected by the request. # @return [Types::Operation] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/AttachCertificateToDistributionResult AWS API Documentation # class AttachCertificateToDistributionResult < Struct.new( :operation) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass AttachDiskRequest # data as a hash: # # { # disk_name: "ResourceName", # required # instance_name: "ResourceName", # required # disk_path: "NonEmptyString", # required # } # # @!attribute [rw] disk_name # The unique Lightsail disk name (e.g., `my-disk`). # @return [String] # # @!attribute [rw] instance_name # The name of the Lightsail instance where you want to utilize the # storage disk. # @return [String] # # @!attribute [rw] disk_path # The disk path to expose to the instance (e.g., `/dev/xvdf`). # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/AttachDiskRequest AWS API Documentation # class AttachDiskRequest < Struct.new( :disk_name, :instance_name, :disk_path) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] operations # An array of objects that describe the result of the action, such as # the status of the request, the timestamp of the request, and the # resources affected by the request. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/AttachDiskResult AWS API Documentation # class AttachDiskResult < Struct.new( :operations) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass AttachInstancesToLoadBalancerRequest # data as a hash: # # { # load_balancer_name: "ResourceName", # required # instance_names: ["ResourceName"], # required # } # # @!attribute [rw] load_balancer_name # The name of the load balancer. # @return [String] # # @!attribute [rw] instance_names # An array of strings representing the instance name(s) you want to # attach to your load balancer. # # An instance must be `running` before you can attach it to your load # balancer. # # There are no additional limits on the number of instances you can # attach to your load balancer, aside from the limit of Lightsail # instances you can create in your account (20). # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/AttachInstancesToLoadBalancerRequest AWS API Documentation # class AttachInstancesToLoadBalancerRequest < Struct.new( :load_balancer_name, :instance_names) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] operations # An array of objects that describe the result of the action, such as # the status of the request, the timestamp of the request, and the # resources affected by the request. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/AttachInstancesToLoadBalancerResult AWS API Documentation # class AttachInstancesToLoadBalancerResult < Struct.new( :operations) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass AttachLoadBalancerTlsCertificateRequest # data as a hash: # # { # load_balancer_name: "ResourceName", # required # certificate_name: "ResourceName", # required # } # # @!attribute [rw] load_balancer_name # The name of the load balancer to which you want to associate the # SSL/TLS certificate. # @return [String] # # @!attribute [rw] certificate_name # The name of your SSL/TLS certificate. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/AttachLoadBalancerTlsCertificateRequest AWS API Documentation # class AttachLoadBalancerTlsCertificateRequest < Struct.new( :load_balancer_name, :certificate_name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] operations # An array of objects that describe the result of the action, such as # the status of the request, the timestamp of the request, and the # resources affected by the request. # # These SSL/TLS certificates are only usable by Lightsail load # balancers. You can't get the certificate and use it for another # purpose. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/AttachLoadBalancerTlsCertificateResult AWS API Documentation # class AttachLoadBalancerTlsCertificateResult < Struct.new( :operations) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass AttachStaticIpRequest # data as a hash: # # { # static_ip_name: "ResourceName", # required # instance_name: "ResourceName", # required # } # # @!attribute [rw] static_ip_name # The name of the static IP. # @return [String] # # @!attribute [rw] instance_name # The instance name to which you want to attach the static IP address. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/AttachStaticIpRequest AWS API Documentation # class AttachStaticIpRequest < Struct.new( :static_ip_name, :instance_name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] operations # An array of objects that describe the result of the action, such as # the status of the request, the timestamp of the request, and the # resources affected by the request. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/AttachStaticIpResult AWS API Documentation # class AttachStaticIpResult < Struct.new( :operations) SENSITIVE = [] include Aws::Structure end # Describes a block storage disk that is attached to an instance, and is # included in an automatic snapshot. # # @!attribute [rw] path # The path of the disk (e.g., `/dev/xvdf`). # @return [String] # # @!attribute [rw] size_in_gb # The size of the disk in GB. # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/AttachedDisk AWS API Documentation # class AttachedDisk < Struct.new( :path, :size_in_gb) SENSITIVE = [] include Aws::Structure end # Describes a request to enable or modify the automatic snapshot add-on # for an Amazon Lightsail instance or disk. # # When you modify the automatic snapshot time for a resource, it is # typically effective immediately except under the following conditions: # # * If an automatic snapshot has been created for the current day, and # you change the snapshot time to a later time of day, then the new # snapshot time will be effective the following day. This ensures that # two snapshots are not created for the current day. # # * If an automatic snapshot has not yet been created for the current # day, and you change the snapshot time to an earlier time of day, # then the new snapshot time will be effective the following day and a # snapshot is automatically created at the previously set time for the # current day. This ensures that a snapshot is created for the current # day. # # * If an automatic snapshot has not yet been created for the current # day, and you change the snapshot time to a time that is within 30 # minutes from your current time, then the new snapshot time will be # effective the following day and a snapshot is automatically created # at the previously set time for the current day. This ensures that a # snapshot is created for the current day, because 30 minutes is # required between your current time and the new snapshot time that # you specify. # # * If an automatic snapshot is scheduled to be created within 30 # minutes from your current time and you change the snapshot time, # then the new snapshot time will be effective the following day and a # snapshot is automatically created at the previously set time for the # current day. This ensures that a snapshot is created for the current # day, because 30 minutes is required between your current time and # the new snapshot time that you specify. # # @note When making an API call, you may pass AutoSnapshotAddOnRequest # data as a hash: # # { # snapshot_time_of_day: "TimeOfDay", # } # # @!attribute [rw] snapshot_time_of_day # The daily time when an automatic snapshot will be created. # # Constraints: # # * Must be in `HH:00` format, and in an hourly increment. # # * Specified in Coordinated Universal Time (UTC). # # * The snapshot will be automatically created between the time # specified and up to 45 minutes after. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/AutoSnapshotAddOnRequest AWS API Documentation # class AutoSnapshotAddOnRequest < Struct.new( :snapshot_time_of_day) SENSITIVE = [] include Aws::Structure end # Describes an automatic snapshot. # # @!attribute [rw] date # The date of the automatic snapshot in `YYYY-MM-DD` format. # @return [String] # # @!attribute [rw] created_at # The timestamp when the automatic snapshot was created. # @return [Time] # # @!attribute [rw] status # The status of the automatic snapshot. # @return [String] # # @!attribute [rw] from_attached_disks # An array of objects that describe the block storage disks attached # to the instance when the automatic snapshot was created. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/AutoSnapshotDetails AWS API Documentation # class AutoSnapshotDetails < Struct.new( :date, :created_at, :status, :from_attached_disks) SENSITIVE = [] include Aws::Structure end # Describes an Availability Zone. # # @!attribute [rw] zone_name # The name of the Availability Zone. The format is `us-east-2a` # (case-sensitive). # @return [String] # # @!attribute [rw] state # The state of the Availability Zone. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/AvailabilityZone AWS API Documentation # class AvailabilityZone < Struct.new( :zone_name, :state) SENSITIVE = [] include Aws::Structure end # Describes a blueprint (a virtual private server image). # # @!attribute [rw] blueprint_id # The ID for the virtual private server image (e.g., # `app_wordpress_4_4` or `app_lamp_7_0`). # @return [String] # # @!attribute [rw] name # The friendly name of the blueprint (e.g., `Amazon Linux`). # @return [String] # # @!attribute [rw] group # The group name of the blueprint (e.g., `amazon-linux`). # @return [String] # # @!attribute [rw] type # The type of the blueprint (e.g., `os` or `app`). # @return [String] # # @!attribute [rw] description # The description of the blueprint. # @return [String] # # @!attribute [rw] is_active # A Boolean value indicating whether the blueprint is active. Inactive # blueprints are listed to support customers with existing instances # but are not necessarily available for launch of new instances. # Blueprints are marked inactive when they become outdated due to # operating system updates or new application releases. # @return [Boolean] # # @!attribute [rw] min_power # The minimum bundle power required to run this blueprint. For # example, you need a bundle with a power value of 500 or more to # create an instance that uses a blueprint with a minimum power value # of 500. `0` indicates that the blueprint runs on all instance sizes. # @return [Integer] # # @!attribute [rw] version # The version number of the operating system, application, or stack # (e.g., `2016.03.0`). # @return [String] # # @!attribute [rw] version_code # The version code. # @return [String] # # @!attribute [rw] product_url # The product URL to learn more about the image or blueprint. # @return [String] # # @!attribute [rw] license_url # The end-user license agreement URL for the image or blueprint. # @return [String] # # @!attribute [rw] platform # The operating system platform (either Linux/Unix-based or Windows # Server-based) of the blueprint. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/Blueprint AWS API Documentation # class Blueprint < Struct.new( :blueprint_id, :name, :group, :type, :description, :is_active, :min_power, :version, :version_code, :product_url, :license_url, :platform) SENSITIVE = [] include Aws::Structure end # Describes an Amazon Lightsail bucket. # # @!attribute [rw] resource_type # The Lightsail resource type of the bucket (for example, `Bucket`). # @return [String] # # @!attribute [rw] access_rules # An object that describes the access rules of the bucket. # @return [Types::AccessRules] # # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the bucket. # @return [String] # # @!attribute [rw] bundle_id # The ID of the bundle currently applied to the bucket. # # A bucket bundle specifies the monthly cost, storage space, and data # transfer quota for a bucket. # # Use the UpdateBucketBundle action to change the bundle of a bucket. # @return [String] # # @!attribute [rw] created_at # The timestamp when the distribution was created. # @return [Time] # # @!attribute [rw] url # The URL of the bucket. # @return [String] # # @!attribute [rw] location # Describes the resource location. # @return [Types::ResourceLocation] # # @!attribute [rw] name # The name of the bucket. # @return [String] # # @!attribute [rw] support_code # The support code for a bucket. Include this code in your email to # support when you have questions about a Lightsail bucket. This code # enables our support team to look up your Lightsail information more # easily. # @return [String] # # @!attribute [rw] tags # The tag keys and optional values for the bucket. For more # information, see [Tags in Amazon Lightsail][1] in the *Amazon # Lightsail Developer Guide*. # # # # [1]: https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-tags # @return [Array] # # @!attribute [rw] object_versioning # Indicates whether object versioning is enabled for the bucket. # # The following options can be configured: # # * `Enabled` - Object versioning is enabled. # # * `Suspended` - Object versioning was previously enabled but is # currently suspended. Existing object versions are retained. # # * `NeverEnabled` - Object versioning has never been enabled. # @return [String] # # @!attribute [rw] able_to_update_bundle # Indicates whether the bundle that is currently applied to a bucket # can be changed to another bundle. # # You can update a bucket's bundle only one time within a monthly AWS # billing cycle. # # Use the UpdateBucketBundle action to change a bucket's bundle. # @return [Boolean] # # @!attribute [rw] readonly_access_accounts # An array of strings that specify the AWS account IDs that have # read-only access to the bucket. # @return [Array] # # @!attribute [rw] resources_receiving_access # An array of objects that describe Lightsail instances that have # access to the bucket. # # Use the SetResourceAccessForBucket action to update the instances # that have access to a bucket. # @return [Array] # # @!attribute [rw] state # An object that describes the state of the bucket. # @return [Types::BucketState] # # @!attribute [rw] access_log_config # An object that describes the access log configuration for the # bucket. # @return [Types::BucketAccessLogConfig] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/Bucket AWS API Documentation # class Bucket < Struct.new( :resource_type, :access_rules, :arn, :bundle_id, :created_at, :url, :location, :name, :support_code, :tags, :object_versioning, :able_to_update_bundle, :readonly_access_accounts, :resources_receiving_access, :state, :access_log_config) SENSITIVE = [] include Aws::Structure end # Describes the access log configuration for a bucket in the Amazon # Lightsail object storage service. # # For more information about bucket access logs, see [Logging bucket # requests using access logging in Amazon Lightsail][1] in the *Amazon # Lightsail Developer Guide*. # # # # [1]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-bucket-access-logs # # @note When making an API call, you may pass BucketAccessLogConfig # data as a hash: # # { # enabled: false, # required # destination: "BucketName", # prefix: "BucketAccessLogPrefix", # } # # @!attribute [rw] enabled # A Boolean value that indicates whether bucket access logging is # enabled for the bucket. # @return [Boolean] # # @!attribute [rw] destination # The name of the bucket where the access is saved. The destination # can be a Lightsail bucket in the same account, and in the same AWS # Region as the source bucket. # # This parameter is required when enabling the access log for a # bucket, and should be omitted when disabling the access log. # # # @return [String] # # @!attribute [rw] prefix # The optional object prefix for the bucket access log. # # The prefix is an optional addition to the object key that organizes # your access log files in the destination bucket. For example, if you # specify a `logs/` prefix, then each log object will begin with the # `logs/` prefix in its key (for example, # `logs/2021-11-01-21-32-16-E568B2907131C0C0`). # # This parameter can be optionally specified when enabling the access # log for a bucket, and should be omitted when disabling the access # log. # # # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/BucketAccessLogConfig AWS API Documentation # class BucketAccessLogConfig < Struct.new( :enabled, :destination, :prefix) SENSITIVE = [] include Aws::Structure end # Describes the specifications of a bundle that can be applied to an # Amazon Lightsail bucket. # # A bucket bundle specifies the monthly cost, storage space, and data # transfer quota for a bucket. # # @!attribute [rw] bundle_id # The ID of the bundle. # @return [String] # # @!attribute [rw] name # The name of the bundle. # @return [String] # # @!attribute [rw] price # The monthly price of the bundle, in US dollars. # @return [Float] # # @!attribute [rw] storage_per_month_in_gb # The storage size of the bundle, in GB. # @return [Integer] # # @!attribute [rw] transfer_per_month_in_gb # The monthly network transfer quota of the bundle. # @return [Integer] # # @!attribute [rw] is_active # Indicates whether the bundle is active. Use for a new or existing # bucket. # @return [Boolean] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/BucketBundle AWS API Documentation # class BucketBundle < Struct.new( :bundle_id, :name, :price, :storage_per_month_in_gb, :transfer_per_month_in_gb, :is_active) SENSITIVE = [] include Aws::Structure end # Describes the state of an Amazon Lightsail bucket. # # @!attribute [rw] code # The state code of the bucket. # # The following codes are possible: # # * `OK` - The bucket is in a running state. # # * `Unknown` - Creation of the bucket might have timed-out. You might # want to delete the bucket and create a new one. # @return [String] # # @!attribute [rw] message # A message that describes the state of the bucket. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/BucketState AWS API Documentation # class BucketState < Struct.new( :code, :message) SENSITIVE = [] include Aws::Structure end # Describes a bundle, which is a set of specs describing your virtual # private server (or *instance*). # # @!attribute [rw] price # The price in US dollars (e.g., `5.0`) of the bundle. # @return [Float] # # @!attribute [rw] cpu_count # The number of vCPUs included in the bundle (e.g., `2`). # @return [Integer] # # @!attribute [rw] disk_size_in_gb # The size of the SSD (e.g., `30`). # @return [Integer] # # @!attribute [rw] bundle_id # The bundle ID (e.g., `micro_1_0`). # @return [String] # # @!attribute [rw] instance_type # The Amazon EC2 instance type (e.g., `t2.micro`). # @return [String] # # @!attribute [rw] is_active # A Boolean value indicating whether the bundle is active. # @return [Boolean] # # @!attribute [rw] name # A friendly name for the bundle (e.g., `Micro`). # @return [String] # # @!attribute [rw] power # A numeric value that represents the power of the bundle (e.g., # `500`). You can use the bundle's power value in conjunction with a # blueprint's minimum power value to determine whether the blueprint # will run on the bundle. For example, you need a bundle with a power # value of 500 or more to create an instance that uses a blueprint # with a minimum power value of 500. # @return [Integer] # # @!attribute [rw] ram_size_in_gb # The amount of RAM in GB (e.g., `2.0`). # @return [Float] # # @!attribute [rw] transfer_per_month_in_gb # The data transfer rate per month in GB (e.g., `2000`). # @return [Integer] # # @!attribute [rw] supported_platforms # The operating system platform (Linux/Unix-based or Windows # Server-based) that the bundle supports. You can only launch a # `WINDOWS` bundle on a blueprint that supports the `WINDOWS` # platform. `LINUX_UNIX` blueprints require a `LINUX_UNIX` bundle. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/Bundle AWS API Documentation # class Bundle < Struct.new( :price, :cpu_count, :disk_size_in_gb, :bundle_id, :instance_type, :is_active, :name, :power, :ram_size_in_gb, :transfer_per_month_in_gb, :supported_platforms) SENSITIVE = [] include Aws::Structure end # Describes the default cache behavior of an Amazon Lightsail content # delivery network (CDN) distribution. # # @note When making an API call, you may pass CacheBehavior # data as a hash: # # { # behavior: "dont-cache", # accepts dont-cache, cache # } # # @!attribute [rw] behavior # The cache behavior of the distribution. # # The following cache behaviors can be specified: # # * cache - This option is best for static # sites. When specified, your distribution caches and serves your # entire website as static content. This behavior is ideal for # websites with static content that doesn't change depending on who # views it, or for websites that don't use cookies, headers, or # query strings to personalize content. # # * dont-cache - This option is best for sites # that serve a mix of static and dynamic content. When specified, # your distribution caches and serve only the content that is # specified in the distribution's `CacheBehaviorPerPath` parameter. # This behavior is ideal for websites or web applications that use # cookies, headers, and query strings to personalize content for # individual users. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CacheBehavior AWS API Documentation # class CacheBehavior < Struct.new( :behavior) SENSITIVE = [] include Aws::Structure end # Describes the per-path cache behavior of an Amazon Lightsail content # delivery network (CDN) distribution. # # A per-path cache behavior is used to override, or add an exception to, # the default cache behavior of a distribution. For example, if the # `cacheBehavior` is set to `cache`, then a per-path cache behavior can # be used to specify a directory, file, or file type that your # distribution will cache. Alternately, if the distribution's # `cacheBehavior` is `dont-cache`, then a per-path cache behavior can be # used to specify a directory, file, or file type that your distribution # will not cache. # # if the cacheBehavior's behavior is set to 'cache', then # # @note When making an API call, you may pass CacheBehaviorPerPath # data as a hash: # # { # path: "string", # behavior: "dont-cache", # accepts dont-cache, cache # } # # @!attribute [rw] path # The path to a directory or file to cached, or not cache. Use an # asterisk symbol to specify wildcard directories # (`path/to/assets/*`), and file types (`*.html, *jpg, *js`). # Directories and file paths are case-sensitive. # # Examples: # # * Specify the following to cache all files in the document root of # an Apache web server running on a Lightsail instance. # # `var/www/html/` # # * Specify the following file to cache only the index page in the # document root of an Apache web server. # # `var/www/html/index.html` # # * Specify the following to cache only the .html files in the # document root of an Apache web server. # # `var/www/html/*.html` # # * Specify the following to cache only the .jpg, .png, and .gif files # in the images sub-directory of the document root of an Apache web # server. # # `var/www/html/images/*.jpg` # # `var/www/html/images/*.png` # # `var/www/html/images/*.gif` # # Specify the following to cache all files in the images # sub-directory of the document root of an Apache web server. # # `var/www/html/images/` # @return [String] # # @!attribute [rw] behavior # The cache behavior for the specified path. # # You can specify one of the following per-path cache behaviors: # # * cache - This behavior caches the specified # path. # # * dont-cache - This behavior doesn't cache # the specified path. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CacheBehaviorPerPath AWS API Documentation # class CacheBehaviorPerPath < Struct.new( :path, :behavior) SENSITIVE = [] include Aws::Structure end # Describes the cache settings of an Amazon Lightsail content delivery # network (CDN) distribution. # # These settings apply only to your distribution's `cacheBehaviors` # (including the `defaultCacheBehavior`) that have a `behavior` of # `cache`. # # @note When making an API call, you may pass CacheSettings # data as a hash: # # { # default_ttl: 1, # minimum_ttl: 1, # maximum_ttl: 1, # allowed_http_methods: "NonEmptyString", # cached_http_methods: "NonEmptyString", # forwarded_cookies: { # option: "none", # accepts none, allow-list, all # cookies_allow_list: ["string"], # }, # forwarded_headers: { # option: "none", # accepts none, allow-list, all # headers_allow_list: ["Accept"], # accepts Accept, Accept-Charset, Accept-Datetime, Accept-Encoding, Accept-Language, Authorization, CloudFront-Forwarded-Proto, CloudFront-Is-Desktop-Viewer, CloudFront-Is-Mobile-Viewer, CloudFront-Is-SmartTV-Viewer, CloudFront-Is-Tablet-Viewer, CloudFront-Viewer-Country, Host, Origin, Referer # }, # forwarded_query_strings: { # option: false, # query_strings_allow_list: ["string"], # }, # } # # @!attribute [rw] default_ttl # The default amount of time that objects stay in the distribution's # cache before the distribution forwards another request to the origin # to determine whether the content has been updated. # # The value specified applies only when the origin does not add HTTP # headers such as `Cache-Control max-age`, `Cache-Control s-maxage`, # and `Expires` to objects. # # # @return [Integer] # # @!attribute [rw] minimum_ttl # The minimum amount of time that objects stay in the distribution's # cache before the distribution forwards another request to the origin # to determine whether the object has been updated. # # A value of `0` must be specified for `minimumTTL` if the # distribution is configured to forward all headers to the origin. # @return [Integer] # # @!attribute [rw] maximum_ttl # The maximum amount of time that objects stay in the distribution's # cache before the distribution forwards another request to the origin # to determine whether the object has been updated. # # The value specified applies only when the origin adds HTTP headers # such as `Cache-Control max-age`, `Cache-Control s-maxage`, and # `Expires` to objects. # @return [Integer] # # @!attribute [rw] allowed_http_methods # The HTTP methods that are processed and forwarded to the # distribution's origin. # # You can specify the following options: # # * `GET,HEAD` - The distribution forwards the `GET` and `HEAD` # methods. # # * `GET,HEAD,OPTIONS` - The distribution forwards the `GET`, `HEAD`, # and `OPTIONS` methods. # # * `GET,HEAD,OPTIONS,PUT,PATCH,POST,DELETE` - The distribution # forwards the `GET`, `HEAD`, `OPTIONS`, `PUT`, `PATCH`, `POST`, and # `DELETE` methods. # # If you specify the third option, you might need to restrict access # to your distribution's origin so users can't perform operations # that you don't want them to. For example, you might not want users # to have permission to delete objects from your origin. # @return [String] # # @!attribute [rw] cached_http_methods # The HTTP method responses that are cached by your distribution. # # You can specify the following options: # # * `GET,HEAD` - The distribution caches responses to the `GET` and # `HEAD` methods. # # * `GET,HEAD,OPTIONS` - The distribution caches responses to the # `GET`, `HEAD`, and `OPTIONS` methods. # @return [String] # # @!attribute [rw] forwarded_cookies # An object that describes the cookies that are forwarded to the # origin. Your content is cached based on the cookies that are # forwarded. # @return [Types::CookieObject] # # @!attribute [rw] forwarded_headers # An object that describes the headers that are forwarded to the # origin. Your content is cached based on the headers that are # forwarded. # @return [Types::HeaderObject] # # @!attribute [rw] forwarded_query_strings # An object that describes the query strings that are forwarded to the # origin. Your content is cached based on the query strings that are # forwarded. # @return [Types::QueryStringObject] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CacheSettings AWS API Documentation # class CacheSettings < Struct.new( :default_ttl, :minimum_ttl, :maximum_ttl, :allowed_http_methods, :cached_http_methods, :forwarded_cookies, :forwarded_headers, :forwarded_query_strings) SENSITIVE = [] include Aws::Structure end # Describes the full details of an Amazon Lightsail SSL/TLS certificate. # # To get a summary of a certificate, use the `GetCertificates` action # and ommit `includeCertificateDetails` from your request. The response # will include only the certificate Amazon Resource Name (ARN), # certificate name, domain name, and tags. # # # # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the certificate. # @return [String] # # @!attribute [rw] name # The name of the certificate (e.g., `my-certificate`). # @return [String] # # @!attribute [rw] domain_name # The domain name of the certificate. # @return [String] # # @!attribute [rw] status # The validation status of the certificate. # @return [String] # # @!attribute [rw] serial_number # The serial number of the certificate. # @return [String] # # @!attribute [rw] subject_alternative_names # An array of strings that specify the alternate domains (e.g., # `example2.com`) and subdomains (e.g., `blog.example.com`) of the # certificate. # @return [Array] # # @!attribute [rw] domain_validation_records # An array of objects that describe the domain validation records of # the certificate. # @return [Array] # # @!attribute [rw] request_failure_reason # The validation failure reason, if any, of the certificate. # # The following failure reasons are possible: # # * NO_AVAILABLE_CONTACTS - This failure applies # to email validation, which is not available for Lightsail # certificates. # # * ADDITIONAL_VERIFICATION_REQUIRED - Lightsail # requires additional information to process this certificate # request. This can happen as a fraud-protection measure, such as # when the domain ranks within the Alexa top 1000 websites. To # provide the required information, use the [AWS Support Center][1] # to contact AWS Support. # # You cannot request a certificate for Amazon-owned domain names # such as those ending in amazonaws.com, cloudfront.net, or # elasticbeanstalk.com. # # # # * DOMAIN_NOT_ALLOWED - One or more of the # domain names in the certificate request was reported as an unsafe # domain by [VirusTotal][2]. To correct the problem, search for your # domain name on the [VirusTotal][2] website. If your domain is # reported as suspicious, see [Google Help for Hacked Websites][3] # to learn what you can do. # # If you believe that the result is a false positive, notify the # organization that is reporting the domain. VirusTotal is an # aggregate of several antivirus and URL scanners and cannot remove # your domain from a block list itself. After you correct the # problem and the VirusTotal registry has been updated, request a # new certificate. # # If you see this error and your domain is not included in the # VirusTotal list, visit the [AWS Support Center][1] and create a # case. # # * INVALID_PUBLIC_DOMAIN - One or more of the # domain names in the certificate request is not valid. Typically, # this is because a domain name in the request is not a valid # top-level domain. Try to request a certificate again, correcting # any spelling errors or typos that were in the failed request, and # ensure that all domain names in the request are for valid # top-level domains. For example, you cannot request a certificate # for `example.invalidpublicdomain` because `invalidpublicdomain` is # not a valid top-level domain. # # * OTHER - Typically, this failure occurs when # there is a typographical error in one or more of the domain names # in the certificate request. Try to request a certificate again, # correcting any spelling errors or typos that were in the failed # request. # # # # [1]: https://console.aws.amazon.com/support/home # [2]: https://www.virustotal.com/gui/home/url # [3]: https://developers.google.com/web/fundamentals/security/hacked # @return [String] # # @!attribute [rw] in_use_resource_count # The number of Lightsail resources that the certificate is attached # to. # @return [Integer] # # @!attribute [rw] key_algorithm # The algorithm used to generate the key pair (the public and private # key) of the certificate. # @return [String] # # @!attribute [rw] created_at # The timestamp when the certificate was created. # @return [Time] # # @!attribute [rw] issued_at # The timestamp when the certificate was issued. # @return [Time] # # @!attribute [rw] issuer_ca # The certificate authority that issued the certificate. # @return [String] # # @!attribute [rw] not_before # The timestamp when the certificate is first valid. # @return [Time] # # @!attribute [rw] not_after # The timestamp when the certificate expires. # @return [Time] # # @!attribute [rw] eligible_to_renew # The renewal eligibility of the certificate. # @return [String] # # @!attribute [rw] renewal_summary # An object that describes the status of the certificate renewal # managed by Lightsail. # @return [Types::RenewalSummary] # # @!attribute [rw] revoked_at # The timestamp when the certificate was revoked. This value is # present only when the certificate status is `REVOKED`. # @return [Time] # # @!attribute [rw] revocation_reason # The reason the certificate was revoked. This value is present only # when the certificate status is `REVOKED`. # @return [String] # # @!attribute [rw] tags # The tag keys and optional values for the resource. For more # information about tags in Lightsail, see the [Amazon Lightsail # Developer Guide][1]. # # # # [1]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags # @return [Array] # # @!attribute [rw] support_code # The support code. Include this code in your email to support when # you have questions about your Lightsail certificate. This code # enables our support team to look up your Lightsail information more # easily. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/Certificate AWS API Documentation # class Certificate < Struct.new( :arn, :name, :domain_name, :status, :serial_number, :subject_alternative_names, :domain_validation_records, :request_failure_reason, :in_use_resource_count, :key_algorithm, :created_at, :issued_at, :issuer_ca, :not_before, :not_after, :eligible_to_renew, :renewal_summary, :revoked_at, :revocation_reason, :tags, :support_code) SENSITIVE = [] include Aws::Structure end # Describes an Amazon Lightsail SSL/TLS certificate. # # @!attribute [rw] certificate_arn # The Amazon Resource Name (ARN) of the certificate. # @return [String] # # @!attribute [rw] certificate_name # The name of the certificate. # @return [String] # # @!attribute [rw] domain_name # The domain name of the certificate. # @return [String] # # @!attribute [rw] certificate_detail # An object that describes a certificate in detail. # @return [Types::Certificate] # # @!attribute [rw] tags # The tag keys and optional values for the resource. For more # information about tags in Lightsail, see the [Amazon Lightsail # Developer Guide][1]. # # # # [1]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CertificateSummary AWS API Documentation # class CertificateSummary < Struct.new( :certificate_arn, :certificate_name, :domain_name, :certificate_detail, :tags) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass CloseInstancePublicPortsRequest # data as a hash: # # { # port_info: { # required # from_port: 1, # to_port: 1, # protocol: "tcp", # accepts tcp, all, udp, icmp # cidrs: ["string"], # ipv6_cidrs: ["string"], # cidr_list_aliases: ["string"], # }, # instance_name: "ResourceName", # required # } # # @!attribute [rw] port_info # An object to describe the ports to close for the specified instance. # @return [Types::PortInfo] # # @!attribute [rw] instance_name # The name of the instance for which to close ports. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CloseInstancePublicPortsRequest AWS API Documentation # class CloseInstancePublicPortsRequest < Struct.new( :port_info, :instance_name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] operation # An object that describes the result of the action, such as the # status of the request, the timestamp of the request, and the # resources affected by the request. # @return [Types::Operation] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CloseInstancePublicPortsResult AWS API Documentation # class CloseInstancePublicPortsResult < Struct.new( :operation) SENSITIVE = [] include Aws::Structure end # Describes a CloudFormation stack record created as a result of the # `create cloud formation stack` action. # # A CloudFormation stack record provides information about the AWS # CloudFormation stack used to create a new Amazon Elastic Compute Cloud # instance from an exported Lightsail instance snapshot. # # @!attribute [rw] name # The name of the CloudFormation stack record. It starts with # `CloudFormationStackRecord` followed by a GUID. # @return [String] # # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the CloudFormation stack record. # @return [String] # # @!attribute [rw] created_at # The date when the CloudFormation stack record was created. # @return [Time] # # @!attribute [rw] location # A list of objects describing the Availability Zone and AWS Region of # the CloudFormation stack record. # @return [Types::ResourceLocation] # # @!attribute [rw] resource_type # The Lightsail resource type (e.g., `CloudFormationStackRecord`). # @return [String] # # @!attribute [rw] state # The current state of the CloudFormation stack record. # @return [String] # # @!attribute [rw] source_info # A list of objects describing the source of the CloudFormation stack # record. # @return [Array] # # @!attribute [rw] destination_info # A list of objects describing the destination service, which is AWS # CloudFormation, and the Amazon Resource Name (ARN) of the AWS # CloudFormation stack. # @return [Types::DestinationInfo] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CloudFormationStackRecord AWS API Documentation # class CloudFormationStackRecord < Struct.new( :name, :arn, :created_at, :location, :resource_type, :state, :source_info, :destination_info) SENSITIVE = [] include Aws::Structure end # Describes the source of a CloudFormation stack record (i.e., the # export snapshot record). # # @!attribute [rw] resource_type # The Lightsail resource type (e.g., `ExportSnapshotRecord`). # @return [String] # # @!attribute [rw] name # The name of the record. # @return [String] # # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the export snapshot record. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CloudFormationStackRecordSourceInfo AWS API Documentation # class CloudFormationStackRecordSourceInfo < Struct.new( :resource_type, :name, :arn) SENSITIVE = [] include Aws::Structure end # Describes a contact method. # # A contact method is a way to send you notifications. For more # information, see [Notifications in Amazon Lightsail][1]. # # # # [1]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-notifications # # @!attribute [rw] contact_endpoint # The destination of the contact method, such as an email address or a # mobile phone number. # @return [String] # # @!attribute [rw] status # The current status of the contact method. # # A contact method has the following possible status: # # * `PendingVerification` - The contact method has not yet been # verified, and the verification has not yet expired. # # * `Valid` - The contact method has been verified. # # * `InValid` - An attempt was made to verify the contact method, but # the verification has expired. # @return [String] # # @!attribute [rw] protocol # The protocol of the contact method, such as email or SMS (text # messaging). # @return [String] # # @!attribute [rw] name # The name of the contact method. # @return [String] # # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the contact method. # @return [String] # # @!attribute [rw] created_at # The timestamp when the contact method was created. # @return [Time] # # @!attribute [rw] location # Describes the resource location. # @return [Types::ResourceLocation] # # @!attribute [rw] resource_type # The Lightsail resource type (e.g., `ContactMethod`). # @return [String] # # @!attribute [rw] support_code # The support code. Include this code in your email to support when # you have questions about your Lightsail contact method. This code # enables our support team to look up your Lightsail information more # easily. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/ContactMethod AWS API Documentation # class ContactMethod < Struct.new( :contact_endpoint, :status, :protocol, :name, :arn, :created_at, :location, :resource_type, :support_code) SENSITIVE = [] include Aws::Structure end # Describes the settings of a container that will be launched, or that # is launched, to an Amazon Lightsail container service. # # @note When making an API call, you may pass Container # data as a hash: # # { # image: "string", # command: ["string"], # environment: { # "string" => "string", # }, # ports: { # "string" => "HTTP", # accepts HTTP, HTTPS, TCP, UDP # }, # } # # @!attribute [rw] image # The name of the image used for the container. # # Container images sourced from your Lightsail container service, that # are registered and stored on your service, start with a colon (`:`). # For example, if your container service name is # `container-service-1`, the container image label is `mystaticsite`, # and you want to use the third (`3`) version of the registered # container image, then you should specify # `:container-service-1.mystaticsite.3`. To use the latest version of # a container image, specify `latest` instead of a version number (for # example, `:container-service-1.mystaticsite.latest`). Lightsail will # automatically use the highest numbered version of the registered # container image. # # Container images sourced from a public registry like Docker Hub # don't start with a colon. For example, `nginx:latest` or `nginx`. # @return [String] # # @!attribute [rw] command # The launch command for the container. # @return [Array] # # @!attribute [rw] environment # The environment variables of the container. # @return [Hash] # # @!attribute [rw] ports # The open firewall ports of the container. # @return [Hash] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/Container AWS API Documentation # class Container < Struct.new( :image, :command, :environment, :ports) SENSITIVE = [] include Aws::Structure end # Describes a container image that is registered to an Amazon Lightsail # container service. # # @!attribute [rw] image # The name of the container image. # @return [String] # # @!attribute [rw] digest # The digest of the container image. # @return [String] # # @!attribute [rw] created_at # The timestamp when the container image was created. # @return [Time] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/ContainerImage AWS API Documentation # class ContainerImage < Struct.new( :image, :digest, :created_at) SENSITIVE = [] include Aws::Structure end # Describes an Amazon Lightsail container service. # # @!attribute [rw] container_service_name # The name of the container service. # @return [String] # # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the container service. # @return [String] # # @!attribute [rw] created_at # The timestamp when the container service was created. # @return [Time] # # @!attribute [rw] location # An object that describes the location of the container service, such # as the AWS Region and Availability Zone. # @return [Types::ResourceLocation] # # @!attribute [rw] resource_type # The Lightsail resource type of the container service (i.e., # `ContainerService`). # @return [String] # # @!attribute [rw] tags # The tag keys and optional values for the resource. For more # information about tags in Lightsail, see the [Amazon Lightsail # Developer Guide][1]. # # # # [1]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags # @return [Array] # # @!attribute [rw] power # The power specification of the container service. # # The power specifies the amount of RAM, the number of vCPUs, and the # base price of the container service. # @return [String] # # @!attribute [rw] power_id # The ID of the power of the container service. # @return [String] # # @!attribute [rw] state # The current state of the container service. # # The following container service states are possible: # # * `PENDING` - The container service is being created. # # * `READY` - The container service is running but it does not have an # active container deployment. # # * `DEPLOYING` - The container service is launching a container # deployment. # # * `RUNNING` - The container service is running and it has an active # container deployment. # # * `UPDATING` - The container service capacity or its custom domains # are being updated. # # * `DELETING` - The container service is being deleted. # # * `DISABLED` - The container service is disabled, and its active # deployment and containers, if any, are shut down. # @return [String] # # @!attribute [rw] state_detail # An object that describes the current state of the container service. # # The state detail is populated only when a container service is in a # `PENDING`, `DEPLOYING`, or `UPDATING` state. # # # @return [Types::ContainerServiceStateDetail] # # @!attribute [rw] scale # The scale specification of the container service. # # The scale specifies the allocated compute nodes of the container # service. # @return [Integer] # # @!attribute [rw] current_deployment # An object that describes the current container deployment of the # container service. # @return [Types::ContainerServiceDeployment] # # @!attribute [rw] next_deployment # An object that describes the next deployment of the container # service. # # This value is `null` when there is no deployment in a `pending` # state. # @return [Types::ContainerServiceDeployment] # # @!attribute [rw] is_disabled # A Boolean value indicating whether the container service is # disabled. # @return [Boolean] # # @!attribute [rw] principal_arn # The principal ARN of the container service. # # The principal ARN can be used to create a trust relationship between # your standard AWS account and your Lightsail container service. This # allows you to give your service permission to access resources in # your standard AWS account. # @return [String] # # @!attribute [rw] private_domain_name # The private domain name of the container service. # # The private domain name is accessible only by other resources within # the default virtual private cloud (VPC) of your Lightsail account. # @return [String] # # @!attribute [rw] public_domain_names # The public domain name of 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. # # See `CreateContainerService` or `UpdateContainerService` for # information about how to specify public domain names for your # Lightsail container service. # @return [Hash>] # # @!attribute [rw] url # The publicly accessible URL of the container service. # # If no public endpoint is specified in the `currentDeployment`, this # URL returns a 404 response. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/ContainerService AWS API Documentation # class ContainerService < Struct.new( :container_service_name, :arn, :created_at, :location, :resource_type, :tags, :power, :power_id, :state, :state_detail, :scale, :current_deployment, :next_deployment, :is_disabled, :principal_arn, :private_domain_name, :public_domain_names, :url) SENSITIVE = [] include Aws::Structure end # Describes a container deployment configuration of an Amazon Lightsail # container service. # # A deployment specifies the settings, such as the ports and launch # command, of containers that are deployed to your container service. # # @!attribute [rw] version # The version number of the deployment. # @return [Integer] # # @!attribute [rw] state # The state of the deployment. # # A deployment can be in one of the following states: # # * `Activating` - The deployment is being created. # # * `Active` - The deployment was successfully created, and it's # currently running on the container service. The container service # can have only one deployment in an active state at a time. # # * `Inactive` - The deployment was previously successfully created, # but it is not currently running on the container service. # # * `Failed` - The deployment failed. Use the `GetContainerLog` action # to view the log events for the containers in the deployment to try # to determine the reason for the failure. # @return [String] # # @!attribute [rw] containers # An object that describes the configuration for the containers of the # deployment. # @return [Hash] # # @!attribute [rw] public_endpoint # An object that describes the endpoint of the deployment. # @return [Types::ContainerServiceEndpoint] # # @!attribute [rw] created_at # The timestamp when the deployment was created. # @return [Time] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/ContainerServiceDeployment AWS API Documentation # class ContainerServiceDeployment < Struct.new( :version, :state, :containers, :public_endpoint, :created_at) SENSITIVE = [] include Aws::Structure end # Describes a container deployment configuration of an Amazon Lightsail # container service. # # A deployment specifies the settings, such as the ports and launch # command, of containers that are deployed to your container service. # # @note When making an API call, you may pass ContainerServiceDeploymentRequest # data as a hash: # # { # containers: { # "ContainerName" => { # image: "string", # command: ["string"], # environment: { # "string" => "string", # }, # ports: { # "string" => "HTTP", # accepts HTTP, HTTPS, TCP, UDP # }, # }, # }, # public_endpoint: { # container_name: "string", # required # container_port: 1, # required # health_check: { # healthy_threshold: 1, # unhealthy_threshold: 1, # timeout_seconds: 1, # interval_seconds: 1, # path: "string", # success_codes: "string", # }, # }, # } # # @!attribute [rw] containers # An object that describes the configuration for the containers of the # deployment. # @return [Hash] # # @!attribute [rw] public_endpoint # An object that describes the endpoint of the deployment. # @return [Types::EndpointRequest] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/ContainerServiceDeploymentRequest AWS API Documentation # class ContainerServiceDeploymentRequest < Struct.new( :containers, :public_endpoint) SENSITIVE = [] include Aws::Structure end # Describes the public endpoint configuration of a deployment of an # Amazon Lightsail container service. # # @!attribute [rw] container_name # The name of the container entry of the deployment that the endpoint # configuration applies to. # @return [String] # # @!attribute [rw] container_port # The port of the specified container to which traffic is forwarded # to. # @return [Integer] # # @!attribute [rw] health_check # An object that describes the health check configuration of the # container. # @return [Types::ContainerServiceHealthCheckConfig] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/ContainerServiceEndpoint AWS API Documentation # class ContainerServiceEndpoint < Struct.new( :container_name, :container_port, :health_check) SENSITIVE = [] include Aws::Structure end # Describes the health check configuration of an Amazon Lightsail # container service. # # @note When making an API call, you may pass ContainerServiceHealthCheckConfig # data as a hash: # # { # healthy_threshold: 1, # unhealthy_threshold: 1, # timeout_seconds: 1, # interval_seconds: 1, # path: "string", # success_codes: "string", # } # # @!attribute [rw] healthy_threshold # The number of consecutive health checks successes required before # moving the container to the `Healthy` state. The default value is # `2`. # @return [Integer] # # @!attribute [rw] unhealthy_threshold # The number of consecutive health check failures required before # moving the container to the `Unhealthy` state. The default value is # `2`. # @return [Integer] # # @!attribute [rw] timeout_seconds # The amount of time, in seconds, during which no response means a # failed health check. You can specify between 2 and 60 seconds. The # default value is `2`. # @return [Integer] # # @!attribute [rw] interval_seconds # The approximate interval, in seconds, between health checks of an # individual container. You can specify between 5 and 300 seconds. The # default value is `5`. # @return [Integer] # # @!attribute [rw] path # The path on the container on which to perform the health check. The # default value is `/`. # @return [String] # # @!attribute [rw] success_codes # The HTTP codes to use when checking for a successful response from a # container. You can specify values between `200` and `499`. You can # specify multiple values (for example, `200,202`) or a range of # values (for example, `200-299`). # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/ContainerServiceHealthCheckConfig AWS API Documentation # class ContainerServiceHealthCheckConfig < Struct.new( :healthy_threshold, :unhealthy_threshold, :timeout_seconds, :interval_seconds, :path, :success_codes) SENSITIVE = [] include Aws::Structure end # Describes the log events of a container of an Amazon Lightsail # container service. # # @!attribute [rw] created_at # The timestamp when the container service log event was created. # @return [Time] # # @!attribute [rw] message # The message of the container service log event. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/ContainerServiceLogEvent AWS API Documentation # class ContainerServiceLogEvent < Struct.new( :created_at, :message) SENSITIVE = [] include Aws::Structure end # Describes the powers that can be specified for an Amazon Lightsail # container service. # # The power specifies the amount of RAM, the number of vCPUs, and the # base price of the container service. # # @!attribute [rw] power_id # The ID of the power (e.g., `nano-1`). # @return [String] # # @!attribute [rw] price # The monthly price of the power in USD. # @return [Float] # # @!attribute [rw] cpu_count # The number of vCPUs included in the power. # @return [Float] # # @!attribute [rw] ram_size_in_gb # The amount of RAM (in GB) of the power. # @return [Float] # # @!attribute [rw] name # The friendly name of the power (e.g., `nano`). # @return [String] # # @!attribute [rw] is_active # A Boolean value indicating whether the power is active and can be # specified for container services. # @return [Boolean] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/ContainerServicePower AWS API Documentation # class ContainerServicePower < Struct.new( :power_id, :price, :cpu_count, :ram_size_in_gb, :name, :is_active) SENSITIVE = [] include Aws::Structure end # Describes the login information for the container image registry of an # Amazon Lightsail account. # # @!attribute [rw] username # The container service registry username to use to push container # images to the container image registry of a Lightsail account. # @return [String] # # @!attribute [rw] password # The container service registry password to use to push container # images to the container image registry of a Lightsail account # @return [String] # # @!attribute [rw] expires_at # The timestamp of when the container image registry username and # password expire. # # The log in credentials expire 12 hours after they are created, at # which point you will need to create a new set of log in credentials # using the `CreateContainerServiceRegistryLogin` action. # @return [Time] # # @!attribute [rw] registry # The address to use to push container images to the container image # registry of a Lightsail account. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/ContainerServiceRegistryLogin AWS API Documentation # class ContainerServiceRegistryLogin < Struct.new( :username, :password, :expires_at, :registry) SENSITIVE = [] include Aws::Structure end # Describes the current state of a container service. # # @!attribute [rw] code # The state code of the container service. # # The following state codes are possible: # # * The following state codes are possible if your container service # is in a `DEPLOYING` or `UPDATING` state: # # * `CREATING_SYSTEM_RESOURCES` - The system resources for your # container service are being created. # # * `CREATING_NETWORK_INFRASTRUCTURE` - The network infrastructure # for your container service are being created. # # * `PROVISIONING_CERTIFICATE` - The SSL/TLS certificate for your # container service is being created. # # * `PROVISIONING_SERVICE` - Your container service is being # provisioned. # # * `CREATING_DEPLOYMENT` - Your deployment is being created on your # container service. # # * `EVALUATING_HEALTH_CHECK` - The health of your deployment is # being evaluated. # # * `ACTIVATING_DEPLOYMENT` - Your deployment is being activated. # # * The following state codes are possible if your container service # is in a `PENDING` state: # # * `CERTIFICATE_LIMIT_EXCEEDED` - The SSL/TLS certificate required # for your container service exceeds the maximum number of # certificates allowed for your account. # # * `UNKNOWN_ERROR` - An error was experienced when your container # service was being created. # @return [String] # # @!attribute [rw] message # A message that provides more information for the state code. # # The state detail is populated only when a container service is in a # `PENDING`, `DEPLOYING`, or `UPDATING` state. # # # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/ContainerServiceStateDetail AWS API Documentation # class ContainerServiceStateDetail < Struct.new( :code, :message) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] container_services # An array of objects that describe one or more container services. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/ContainerServicesListResult AWS API Documentation # class ContainerServicesListResult < Struct.new( :container_services) SENSITIVE = [] include Aws::Structure end # Describes whether an Amazon Lightsail content delivery network (CDN) # distribution forwards cookies to the origin and, if so, which ones. # # For the cookies that you specify, your distribution caches separate # versions of the specified content based on the cookie values in viewer # requests. # # @note When making an API call, you may pass CookieObject # data as a hash: # # { # option: "none", # accepts none, allow-list, all # cookies_allow_list: ["string"], # } # # @!attribute [rw] option # Specifies which cookies to forward to the distribution's origin for # a cache behavior: `all`, `none`, or `allow-list` to forward only the # cookies specified in the `cookiesAllowList` parameter. # @return [String] # # @!attribute [rw] cookies_allow_list # The specific cookies to forward to your distribution's origin. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CookieObject AWS API Documentation # class CookieObject < Struct.new( :option, :cookies_allow_list) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass CopySnapshotRequest # data as a hash: # # { # source_snapshot_name: "ResourceName", # source_resource_name: "string", # restore_date: "string", # use_latest_restorable_auto_snapshot: false, # target_snapshot_name: "ResourceName", # required # source_region: "us-east-1", # required, accepts us-east-1, us-east-2, us-west-1, us-west-2, eu-west-1, eu-west-2, eu-west-3, eu-central-1, ca-central-1, ap-south-1, ap-southeast-1, ap-southeast-2, ap-northeast-1, ap-northeast-2, eu-north-1 # } # # @!attribute [rw] source_snapshot_name # The name of the source manual snapshot to copy. # # Constraint: # # * Define this parameter only when copying a manual snapshot as # another manual snapshot. # # ^ # @return [String] # # @!attribute [rw] source_resource_name # The name of the source instance or disk from which the source # automatic snapshot was created. # # Constraint: # # * Define this parameter only when copying an automatic snapshot as a # manual snapshot. For more information, see the [Amazon Lightsail # Developer Guide][1]. # # ^ # # # # [1]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-keeping-automatic-snapshots # @return [String] # # @!attribute [rw] restore_date # The date of the source automatic snapshot to copy. Use the `get auto # snapshots` operation to identify the dates of the available # automatic snapshots. # # Constraints: # # * Must be specified in `YYYY-MM-DD` format. # # * This parameter cannot be defined together with the `use latest # restorable auto snapshot` parameter. The `restore date` and `use # latest restorable auto snapshot` parameters are mutually # exclusive. # # * Define this parameter only when copying an automatic snapshot as a # manual snapshot. For more information, see the [Amazon Lightsail # Developer Guide][1]. # # # # [1]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-keeping-automatic-snapshots # @return [String] # # @!attribute [rw] use_latest_restorable_auto_snapshot # A Boolean value to indicate whether to use the latest available # automatic snapshot of the specified source instance or disk. # # Constraints: # # * This parameter cannot be defined together with the `restore date` # parameter. The `use latest restorable auto snapshot` and `restore # date` parameters are mutually exclusive. # # * Define this parameter only when copying an automatic snapshot as a # manual snapshot. For more information, see the [Amazon Lightsail # Developer Guide][1]. # # # # [1]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-keeping-automatic-snapshots # @return [Boolean] # # @!attribute [rw] target_snapshot_name # The name of the new manual snapshot to be created as a copy. # @return [String] # # @!attribute [rw] source_region # The AWS Region where the source manual or automatic snapshot is # located. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CopySnapshotRequest AWS API Documentation # class CopySnapshotRequest < Struct.new( :source_snapshot_name, :source_resource_name, :restore_date, :use_latest_restorable_auto_snapshot, :target_snapshot_name, :source_region) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] operations # An array of objects that describe the result of the action, such as # the status of the request, the timestamp of the request, and the # resources affected by the request. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CopySnapshotResult AWS API Documentation # class CopySnapshotResult < Struct.new( :operations) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass CreateBucketAccessKeyRequest # data as a hash: # # { # bucket_name: "BucketName", # required # } # # @!attribute [rw] bucket_name # The name of the bucket that the new access key will belong to, and # grant access to. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateBucketAccessKeyRequest AWS API Documentation # class CreateBucketAccessKeyRequest < Struct.new( :bucket_name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] access_key # An object that describes the access key that is created. # @return [Types::AccessKey] # # @!attribute [rw] operations # An array of objects that describe the result of the action, such as # the status of the request, the timestamp of the request, and the # resources affected by the request. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateBucketAccessKeyResult AWS API Documentation # class CreateBucketAccessKeyResult < Struct.new( :access_key, :operations) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass CreateBucketRequest # data as a hash: # # { # bucket_name: "BucketName", # required # bundle_id: "NonEmptyString", # required # tags: [ # { # key: "TagKey", # value: "TagValue", # }, # ], # enable_object_versioning: false, # } # # @!attribute [rw] bucket_name # The name for the bucket. # # For more information about bucket names, see [Bucket naming rules in # Amazon Lightsail][1] in the *Amazon Lightsail Developer Guide*. # # # # [1]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/bucket-naming-rules-in-amazon-lightsail # @return [String] # # @!attribute [rw] bundle_id # The ID of the bundle to use for the bucket. # # A bucket bundle specifies the monthly cost, storage space, and data # transfer quota for a bucket. # # Use the GetBucketBundles action to get a list of bundle IDs that you # can specify. # # Use the UpdateBucketBundle action to change the bundle after the # bucket is created. # @return [String] # # @!attribute [rw] tags # The tag keys and optional values to add to the bucket during # creation. # # Use the TagResource action to tag the bucket after it's created. # @return [Array] # # @!attribute [rw] enable_object_versioning # A Boolean value that indicates whether to enable versioning of # objects in the bucket. # # For more information about versioning, see [Enabling and suspending # object versioning in a bucket in Amazon Lightsail][1] in the *Amazon # Lightsail Developer Guide*. # # # # [1]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-managing-bucket-object-versioning # @return [Boolean] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateBucketRequest AWS API Documentation # class CreateBucketRequest < Struct.new( :bucket_name, :bundle_id, :tags, :enable_object_versioning) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bucket # An object that describes the bucket that is created. # @return [Types::Bucket] # # @!attribute [rw] operations # An array of objects that describe the result of the action, such as # the status of the request, the timestamp of the request, and the # resources affected by the request. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateBucketResult AWS API Documentation # class CreateBucketResult < Struct.new( :bucket, :operations) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass CreateCertificateRequest # data as a hash: # # { # certificate_name: "CertificateName", # required # domain_name: "DomainName", # required # subject_alternative_names: ["DomainName"], # tags: [ # { # key: "TagKey", # value: "TagValue", # }, # ], # } # # @!attribute [rw] certificate_name # The name for the certificate. # @return [String] # # @!attribute [rw] domain_name # The domain name (e.g., `example.com`) for the certificate. # @return [String] # # @!attribute [rw] subject_alternative_names # An array of strings that specify the alternate domains (e.g., # `example2.com`) and subdomains (e.g., `blog.example.com`) for the # certificate. # # You can specify a maximum of nine alternate domains (in addition to # the primary domain name). # # Wildcard domain entries (e.g., `*.example.com`) are not supported. # @return [Array] # # @!attribute [rw] tags # The tag keys and optional values to add to the certificate during # create. # # Use the `TagResource` action to tag a resource after it's created. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateCertificateRequest AWS API Documentation # class CreateCertificateRequest < Struct.new( :certificate_name, :domain_name, :subject_alternative_names, :tags) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] certificate # An object that describes the certificate created. # @return [Types::CertificateSummary] # # @!attribute [rw] operations # An array of objects that describe the result of the action, such as # the status of the request, the timestamp of the request, and the # resources affected by the request. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateCertificateResult AWS API Documentation # class CreateCertificateResult < Struct.new( :certificate, :operations) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass CreateCloudFormationStackRequest # data as a hash: # # { # instances: [ # required # { # source_name: "ResourceName", # required # instance_type: "NonEmptyString", # required # port_info_source: "DEFAULT", # required, accepts DEFAULT, INSTANCE, NONE, CLOSED # user_data: "string", # availability_zone: "string", # required # }, # ], # } # # @!attribute [rw] instances # An array of parameters that will be used to create the new Amazon # EC2 instance. You can only pass one instance entry at a time in this # array. You will get an invalid parameter error if you pass more than # one instance entry in this array. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateCloudFormationStackRequest AWS API Documentation # class CreateCloudFormationStackRequest < Struct.new( :instances) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] operations # An array of objects that describe the result of the action, such as # the status of the request, the timestamp of the request, and the # resources affected by the request. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateCloudFormationStackResult AWS API Documentation # class CreateCloudFormationStackResult < Struct.new( :operations) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass CreateContactMethodRequest # data as a hash: # # { # protocol: "Email", # required, accepts Email, SMS # contact_endpoint: "StringMax256", # required # } # # @!attribute [rw] protocol # The protocol of the contact method, such as `Email` or `SMS` (text # messaging). # # The `SMS` protocol is supported only in the following AWS Regions. # # * US East (N. Virginia) (`us-east-1`) # # * US West (Oregon) (`us-west-2`) # # * Europe (Ireland) (`eu-west-1`) # # * Asia Pacific (Tokyo) (`ap-northeast-1`) # # * Asia Pacific (Singapore) (`ap-southeast-1`) # # * Asia Pacific (Sydney) (`ap-southeast-2`) # # For a list of countries/regions where SMS text messages can be sent, # and the latest AWS Regions where SMS text messaging is supported, # see [Supported Regions and Countries][1] in the *Amazon SNS # Developer Guide*. # # For more information about notifications in Amazon Lightsail, see # [Notifications in Amazon Lightsail][2]. # # # # [1]: https://docs.aws.amazon.com/sns/latest/dg/sns-supported-regions-countries.html # [2]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-notifications # @return [String] # # @!attribute [rw] contact_endpoint # The destination of the contact method, such as an email address or a # mobile phone number. # # Use the E.164 format when specifying a mobile phone number. E.164 is # a standard for the phone number structure used for international # telecommunication. Phone numbers that follow this format can have a # maximum of 15 digits, and they are prefixed with the plus character # (+) and the country code. For example, a U.S. phone number in E.164 # format would be specified as +1XXX5550100. For more information, see # [E.164][1] on *Wikipedia*. # # # # [1]: https://en.wikipedia.org/wiki/E.164 # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateContactMethodRequest AWS API Documentation # class CreateContactMethodRequest < Struct.new( :protocol, :contact_endpoint) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] operations # An array of objects that describe the result of the action, such as # the status of the request, the timestamp of the request, and the # resources affected by the request. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateContactMethodResult AWS API Documentation # class CreateContactMethodResult < Struct.new( :operations) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass CreateContainerServiceDeploymentRequest # data as a hash: # # { # service_name: "ContainerServiceName", # required # containers: { # "ContainerName" => { # image: "string", # command: ["string"], # environment: { # "string" => "string", # }, # ports: { # "string" => "HTTP", # accepts HTTP, HTTPS, TCP, UDP # }, # }, # }, # public_endpoint: { # container_name: "string", # required # container_port: 1, # required # health_check: { # healthy_threshold: 1, # unhealthy_threshold: 1, # timeout_seconds: 1, # interval_seconds: 1, # path: "string", # success_codes: "string", # }, # }, # } # # @!attribute [rw] service_name # The name of the container service for which to create the # deployment. # @return [String] # # @!attribute [rw] containers # An object that describes the settings of the containers that will be # launched on the container service. # @return [Hash] # # @!attribute [rw] public_endpoint # An object that describes the settings of the public endpoint for the # container service. # @return [Types::EndpointRequest] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateContainerServiceDeploymentRequest AWS API Documentation # class CreateContainerServiceDeploymentRequest < Struct.new( :service_name, :containers, :public_endpoint) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] container_service # An object that describes a container service. # @return [Types::ContainerService] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateContainerServiceDeploymentResult AWS API Documentation # class CreateContainerServiceDeploymentResult < Struct.new( :container_service) SENSITIVE = [] include Aws::Structure end # @api private # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateContainerServiceRegistryLoginRequest AWS API Documentation # class CreateContainerServiceRegistryLoginRequest < Aws::EmptyStructure; end # @!attribute [rw] registry_login # An object that describes the log in information for the container # service registry of your Lightsail account. # @return [Types::ContainerServiceRegistryLogin] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateContainerServiceRegistryLoginResult AWS API Documentation # class CreateContainerServiceRegistryLoginResult < Struct.new( :registry_login) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass CreateContainerServiceRequest # data as a hash: # # { # service_name: "ContainerServiceName", # required # power: "nano", # required, accepts nano, micro, small, medium, large, xlarge # scale: 1, # required # tags: [ # { # key: "TagKey", # value: "TagValue", # }, # ], # public_domain_names: { # "string" => ["string"], # }, # deployment: { # containers: { # "ContainerName" => { # image: "string", # command: ["string"], # environment: { # "string" => "string", # }, # ports: { # "string" => "HTTP", # accepts HTTP, HTTPS, TCP, UDP # }, # }, # }, # public_endpoint: { # container_name: "string", # required # container_port: 1, # required # health_check: { # healthy_threshold: 1, # unhealthy_threshold: 1, # timeout_seconds: 1, # interval_seconds: 1, # path: "string", # success_codes: "string", # }, # }, # }, # } # # @!attribute [rw] service_name # The name for the container service. # # The name that you specify for your container service will make up # part of its default domain. The default domain of a container # service is typically # `https://...cs.amazonlightsail.com`. # If the name of your container service is `container-service-1`, and # it's located in the US East (Ohio) AWS region (`us-east-2`), then # the domain for your container service will be like the following # example: # `https://container-service-1.ur4EXAMPLE2uq.us-east-2.cs.amazonlightsail.com` # # The following are the requirements for container service names: # # * Must be unique within each AWS Region in your Lightsail account. # # * Must contain 1 to 63 characters. # # * Must contain only alphanumeric characters and hyphens. # # * A hyphen (-) can separate words but cannot be at the start or end # of the name. # @return [String] # # @!attribute [rw] power # The power specification 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 get a list of power # options that you can specify using this parameter, and their base # monthly cost. # @return [String] # # @!attribute [rw] scale # The scale specification 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. # @return [Integer] # # @!attribute [rw] tags # The tag keys and optional values to add to the container service # during create. # # Use the `TagResource` action to tag a resource after it's created. # # For more information about tags in Lightsail, see the [Amazon # Lightsail Developer Guide][1]. # # # # [1]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags # @return [Array] # # @!attribute [rw] public_domain_names # 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. # @return [Hash>] # # @!attribute [rw] deployment # 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. # @return [Types::ContainerServiceDeploymentRequest] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateContainerServiceRequest AWS API Documentation # class CreateContainerServiceRequest < Struct.new( :service_name, :power, :scale, :tags, :public_domain_names, :deployment) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] container_service # An object that describes a container service. # @return [Types::ContainerService] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateContainerServiceResult AWS API Documentation # class CreateContainerServiceResult < Struct.new( :container_service) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass CreateDiskFromSnapshotRequest # data as a hash: # # { # disk_name: "ResourceName", # required # disk_snapshot_name: "ResourceName", # availability_zone: "NonEmptyString", # required # size_in_gb: 1, # required # tags: [ # { # key: "TagKey", # value: "TagValue", # }, # ], # add_ons: [ # { # add_on_type: "AutoSnapshot", # required, accepts AutoSnapshot # auto_snapshot_add_on_request: { # snapshot_time_of_day: "TimeOfDay", # }, # }, # ], # source_disk_name: "string", # restore_date: "string", # use_latest_restorable_auto_snapshot: false, # } # # @!attribute [rw] disk_name # The unique Lightsail disk name (e.g., `my-disk`). # @return [String] # # @!attribute [rw] disk_snapshot_name # The name of the disk snapshot (e.g., `my-snapshot`) from which to # create the new storage disk. # # Constraint: # # * This parameter cannot be defined together with the `source disk # name` parameter. The `disk snapshot name` and `source disk name` # parameters are mutually exclusive. # # ^ # @return [String] # # @!attribute [rw] availability_zone # The Availability Zone where you want to create the disk (e.g., # `us-east-2a`). Choose the same Availability Zone as the Lightsail # instance where you want to create the disk. # # Use the GetRegions operation to list the Availability Zones where # Lightsail is currently available. # @return [String] # # @!attribute [rw] size_in_gb # The size of the disk in GB (e.g., `32`). # @return [Integer] # # @!attribute [rw] tags # The tag keys and optional values to add to the resource during # create. # # Use the `TagResource` action to tag a resource after it's created. # @return [Array] # # @!attribute [rw] add_ons # An array of objects that represent the add-ons to enable for the new # disk. # @return [Array] # # @!attribute [rw] source_disk_name # The name of the source disk from which the source automatic snapshot # was created. # # Constraints: # # * This parameter cannot be defined together with the `disk snapshot # name` parameter. The `source disk name` and `disk snapshot name` # parameters are mutually exclusive. # # * Define this parameter only when creating a new disk from an # automatic snapshot. For more information, see the [Amazon # Lightsail Developer Guide][1]. # # # # [1]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-automatic-snapshots # @return [String] # # @!attribute [rw] restore_date # The date of the automatic snapshot to use for the new disk. Use the # `get auto snapshots` operation to identify the dates of the # available automatic snapshots. # # Constraints: # # * Must be specified in `YYYY-MM-DD` format. # # * This parameter cannot be defined together with the `use latest # restorable auto snapshot` parameter. The `restore date` and `use # latest restorable auto snapshot` parameters are mutually # exclusive. # # * Define this parameter only when creating a new disk from an # automatic snapshot. For more information, see the [Amazon # Lightsail Developer Guide][1]. # # # # [1]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-automatic-snapshots # @return [String] # # @!attribute [rw] use_latest_restorable_auto_snapshot # A Boolean value to indicate whether to use the latest available # automatic snapshot. # # Constraints: # # * This parameter cannot be defined together with the `restore date` # parameter. The `use latest restorable auto snapshot` and `restore # date` parameters are mutually exclusive. # # * Define this parameter only when creating a new disk from an # automatic snapshot. For more information, see the [Amazon # Lightsail Developer Guide][1]. # # # # [1]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-automatic-snapshots # @return [Boolean] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateDiskFromSnapshotRequest AWS API Documentation # class CreateDiskFromSnapshotRequest < Struct.new( :disk_name, :disk_snapshot_name, :availability_zone, :size_in_gb, :tags, :add_ons, :source_disk_name, :restore_date, :use_latest_restorable_auto_snapshot) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] operations # An array of objects that describe the result of the action, such as # the status of the request, the timestamp of the request, and the # resources affected by the request. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateDiskFromSnapshotResult AWS API Documentation # class CreateDiskFromSnapshotResult < Struct.new( :operations) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass CreateDiskRequest # data as a hash: # # { # disk_name: "ResourceName", # required # availability_zone: "NonEmptyString", # required # size_in_gb: 1, # required # tags: [ # { # key: "TagKey", # value: "TagValue", # }, # ], # add_ons: [ # { # add_on_type: "AutoSnapshot", # required, accepts AutoSnapshot # auto_snapshot_add_on_request: { # snapshot_time_of_day: "TimeOfDay", # }, # }, # ], # } # # @!attribute [rw] disk_name # The unique Lightsail disk name (e.g., `my-disk`). # @return [String] # # @!attribute [rw] availability_zone # The Availability Zone where you want to create the disk (e.g., # `us-east-2a`). Use the same Availability Zone as the Lightsail # instance to which you want to attach the disk. # # Use the `get regions` operation to list the Availability Zones where # Lightsail is currently available. # @return [String] # # @!attribute [rw] size_in_gb # The size of the disk in GB (e.g., `32`). # @return [Integer] # # @!attribute [rw] tags # The tag keys and optional values to add to the resource during # create. # # Use the `TagResource` action to tag a resource after it's created. # @return [Array] # # @!attribute [rw] add_ons # An array of objects that represent the add-ons to enable for the new # disk. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateDiskRequest AWS API Documentation # class CreateDiskRequest < Struct.new( :disk_name, :availability_zone, :size_in_gb, :tags, :add_ons) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] operations # An array of objects that describe the result of the action, such as # the status of the request, the timestamp of the request, and the # resources affected by the request. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateDiskResult AWS API Documentation # class CreateDiskResult < Struct.new( :operations) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass CreateDiskSnapshotRequest # data as a hash: # # { # disk_name: "ResourceName", # disk_snapshot_name: "ResourceName", # required # instance_name: "ResourceName", # tags: [ # { # key: "TagKey", # value: "TagValue", # }, # ], # } # # @!attribute [rw] disk_name # The unique name of the source disk (e.g., `Disk-Virginia-1`). # # This parameter cannot be defined together with the `instance name` # parameter. The `disk name` and `instance name` parameters are # mutually exclusive. # # # @return [String] # # @!attribute [rw] disk_snapshot_name # The name of the destination disk snapshot (e.g., `my-disk-snapshot`) # based on the source disk. # @return [String] # # @!attribute [rw] instance_name # The unique name of the source instance (e.g., # `Amazon_Linux-512MB-Virginia-1`). When this is defined, a snapshot # of the instance's system volume is created. # # This parameter cannot be defined together with the `disk name` # parameter. The `instance name` and `disk name` parameters are # mutually exclusive. # # # @return [String] # # @!attribute [rw] tags # The tag keys and optional values to add to the resource during # create. # # Use the `TagResource` action to tag a resource after it's created. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateDiskSnapshotRequest AWS API Documentation # class CreateDiskSnapshotRequest < Struct.new( :disk_name, :disk_snapshot_name, :instance_name, :tags) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] operations # An array of objects that describe the result of the action, such as # the status of the request, the timestamp of the request, and the # resources affected by the request. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateDiskSnapshotResult AWS API Documentation # class CreateDiskSnapshotResult < Struct.new( :operations) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass CreateDistributionRequest # data as a hash: # # { # distribution_name: "ResourceName", # required # origin: { # required # name: "ResourceName", # region_name: "us-east-1", # accepts us-east-1, us-east-2, us-west-1, us-west-2, eu-west-1, eu-west-2, eu-west-3, eu-central-1, ca-central-1, ap-south-1, ap-southeast-1, ap-southeast-2, ap-northeast-1, ap-northeast-2, eu-north-1 # protocol_policy: "http-only", # accepts http-only, https-only # }, # default_cache_behavior: { # required # behavior: "dont-cache", # accepts dont-cache, cache # }, # cache_behavior_settings: { # default_ttl: 1, # minimum_ttl: 1, # maximum_ttl: 1, # allowed_http_methods: "NonEmptyString", # cached_http_methods: "NonEmptyString", # forwarded_cookies: { # option: "none", # accepts none, allow-list, all # cookies_allow_list: ["string"], # }, # forwarded_headers: { # option: "none", # accepts none, allow-list, all # headers_allow_list: ["Accept"], # accepts Accept, Accept-Charset, Accept-Datetime, Accept-Encoding, Accept-Language, Authorization, CloudFront-Forwarded-Proto, CloudFront-Is-Desktop-Viewer, CloudFront-Is-Mobile-Viewer, CloudFront-Is-SmartTV-Viewer, CloudFront-Is-Tablet-Viewer, CloudFront-Viewer-Country, Host, Origin, Referer # }, # forwarded_query_strings: { # option: false, # query_strings_allow_list: ["string"], # }, # }, # cache_behaviors: [ # { # path: "string", # behavior: "dont-cache", # accepts dont-cache, cache # }, # ], # bundle_id: "string", # required # ip_address_type: "dualstack", # accepts dualstack, ipv4 # tags: [ # { # key: "TagKey", # value: "TagValue", # }, # ], # } # # @!attribute [rw] distribution_name # The name for the distribution. # @return [String] # # @!attribute [rw] origin # 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. # @return [Types::InputOrigin] # # @!attribute [rw] default_cache_behavior # An object that describes the default cache behavior for the # distribution. # @return [Types::CacheBehavior] # # @!attribute [rw] cache_behavior_settings # An object that describes the cache behavior settings for the # distribution. # @return [Types::CacheSettings] # # @!attribute [rw] cache_behaviors # An array of objects that describe the per-path cache behavior for # the distribution. # @return [Array] # # @!attribute [rw] bundle_id # 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. # @return [String] # # @!attribute [rw] ip_address_type # The IP address type for the distribution. # # The possible values are `ipv4` for IPv4 only, and `dualstack` for # IPv4 and IPv6. # # The default value is `dualstack`. # @return [String] # # @!attribute [rw] tags # 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. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateDistributionRequest AWS API Documentation # class CreateDistributionRequest < Struct.new( :distribution_name, :origin, :default_cache_behavior, :cache_behavior_settings, :cache_behaviors, :bundle_id, :ip_address_type, :tags) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] distribution # An object that describes the distribution created. # @return [Types::LightsailDistribution] # # @!attribute [rw] operation # An array of objects that describe the result of the action, such as # the status of the request, the timestamp of the request, and the # resources affected by the request. # @return [Types::Operation] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateDistributionResult AWS API Documentation # class CreateDistributionResult < Struct.new( :distribution, :operation) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass CreateDomainEntryRequest # data as a hash: # # { # domain_name: "DomainName", # required # domain_entry: { # required # id: "NonEmptyString", # name: "DomainName", # target: "string", # is_alias: false, # type: "DomainEntryType", # options: { # "DomainEntryOptionsKeys" => "string", # }, # }, # } # # @!attribute [rw] domain_name # The domain name (e.g., `example.com`) for which you want to create # the domain entry. # @return [String] # # @!attribute [rw] domain_entry # An array of key-value pairs containing information about the domain # entry request. # @return [Types::DomainEntry] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateDomainEntryRequest AWS API Documentation # class CreateDomainEntryRequest < Struct.new( :domain_name, :domain_entry) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] operation # An array of objects that describe the result of the action, such as # the status of the request, the timestamp of the request, and the # resources affected by the request. # @return [Types::Operation] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateDomainEntryResult AWS API Documentation # class CreateDomainEntryResult < Struct.new( :operation) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass CreateDomainRequest # data as a hash: # # { # domain_name: "DomainName", # required # tags: [ # { # key: "TagKey", # value: "TagValue", # }, # ], # } # # @!attribute [rw] domain_name # The domain name to manage (e.g., `example.com`). # # You cannot register a new domain name using Lightsail. You must # register a domain name using Amazon Route 53 or another domain name # registrar. If you have already registered your domain, you can enter # its name in this parameter to manage the DNS records for that domain # using Lightsail. # # # @return [String] # # @!attribute [rw] tags # The tag keys and optional values to add to the resource during # create. # # Use the `TagResource` action to tag a resource after it's created. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateDomainRequest AWS API Documentation # class CreateDomainRequest < Struct.new( :domain_name, :tags) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] operation # An array of objects that describe the result of the action, such as # the status of the request, the timestamp of the request, and the # resources affected by the request. # @return [Types::Operation] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateDomainResult AWS API Documentation # class CreateDomainResult < Struct.new( :operation) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass CreateInstanceSnapshotRequest # data as a hash: # # { # instance_snapshot_name: "ResourceName", # required # instance_name: "ResourceName", # required # tags: [ # { # key: "TagKey", # value: "TagValue", # }, # ], # } # # @!attribute [rw] instance_snapshot_name # The name for your new snapshot. # @return [String] # # @!attribute [rw] instance_name # The Lightsail instance on which to base your snapshot. # @return [String] # # @!attribute [rw] tags # The tag keys and optional values to add to the resource during # create. # # Use the `TagResource` action to tag a resource after it's created. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateInstanceSnapshotRequest AWS API Documentation # class CreateInstanceSnapshotRequest < Struct.new( :instance_snapshot_name, :instance_name, :tags) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] operations # An array of objects that describe the result of the action, such as # the status of the request, the timestamp of the request, and the # resources affected by the request. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateInstanceSnapshotResult AWS API Documentation # class CreateInstanceSnapshotResult < Struct.new( :operations) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass CreateInstancesFromSnapshotRequest # data as a hash: # # { # instance_names: ["string"], # required # attached_disk_mapping: { # "ResourceName" => [ # { # original_disk_path: "NonEmptyString", # new_disk_name: "ResourceName", # }, # ], # }, # availability_zone: "string", # required # instance_snapshot_name: "ResourceName", # bundle_id: "NonEmptyString", # required # user_data: "string", # key_pair_name: "ResourceName", # tags: [ # { # key: "TagKey", # value: "TagValue", # }, # ], # add_ons: [ # { # add_on_type: "AutoSnapshot", # required, accepts AutoSnapshot # auto_snapshot_add_on_request: { # snapshot_time_of_day: "TimeOfDay", # }, # }, # ], # ip_address_type: "dualstack", # accepts dualstack, ipv4 # source_instance_name: "string", # restore_date: "string", # use_latest_restorable_auto_snapshot: false, # } # # @!attribute [rw] instance_names # The names for your new instances. # @return [Array] # # @!attribute [rw] attached_disk_mapping # An object containing information about one or more disk mappings. # @return [Hash>] # # @!attribute [rw] availability_zone # The Availability Zone where you want to create your instances. Use # the following formatting: `us-east-2a` (case sensitive). You can get # a list of Availability Zones by using the [get regions][1] # operation. Be sure to add the `include Availability Zones` parameter # to your request. # # # # [1]: http://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetRegions.html # @return [String] # # @!attribute [rw] instance_snapshot_name # The name of the instance snapshot on which you are basing your new # instances. Use the get instance snapshots operation to return # information about your existing snapshots. # # Constraint: # # * This parameter cannot be defined together with the `source # instance name` parameter. The `instance snapshot name` and `source # instance name` parameters are mutually exclusive. # # ^ # @return [String] # # @!attribute [rw] bundle_id # The bundle of specification information for your virtual private # server (or *instance*), including the pricing plan (e.g., # `micro_1_0`). # @return [String] # # @!attribute [rw] user_data # You can create a launch script that configures a server with # additional user data. For example, `apt-get -y update`. # # Depending on the machine image you choose, the command to get # software on your instance varies. Amazon Linux and CentOS use `yum`, # Debian and Ubuntu use `apt-get`, and FreeBSD uses `pkg`. For a # complete list, see the [Amazon Lightsail Developer Guide][1]. # # # # # # [1]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/compare-options-choose-lightsail-instance-image # @return [String] # # @!attribute [rw] key_pair_name # The name for your key pair. # @return [String] # # @!attribute [rw] tags # The tag keys and optional values to add to the resource during # create. # # Use the `TagResource` action to tag a resource after it's created. # @return [Array] # # @!attribute [rw] add_ons # An array of objects representing the add-ons to enable for the new # instance. # @return [Array] # # @!attribute [rw] ip_address_type # The IP address type for the instance. # # The possible values are `ipv4` for IPv4 only, and `dualstack` for # IPv4 and IPv6. # # The default value is `dualstack`. # @return [String] # # @!attribute [rw] source_instance_name # The name of the source instance from which the source automatic # snapshot was created. # # Constraints: # # * This parameter cannot be defined together with the `instance # snapshot name` parameter. The `source instance name` and `instance # snapshot name` parameters are mutually exclusive. # # * Define this parameter only when creating a new instance from an # automatic snapshot. For more information, see the [Amazon # Lightsail Developer Guide][1]. # # # # [1]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-automatic-snapshots # @return [String] # # @!attribute [rw] restore_date # The date of the automatic snapshot to use for the new instance. Use # the `get auto snapshots` operation to identify the dates of the # available automatic snapshots. # # Constraints: # # * Must be specified in `YYYY-MM-DD` format. # # * This parameter cannot be defined together with the `use latest # restorable auto snapshot` parameter. The `restore date` and `use # latest restorable auto snapshot` parameters are mutually # exclusive. # # * Define this parameter only when creating a new instance from an # automatic snapshot. For more information, see the [Amazon # Lightsail Developer Guide][1]. # # # # [1]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-automatic-snapshots # @return [String] # # @!attribute [rw] use_latest_restorable_auto_snapshot # A Boolean value to indicate whether to use the latest available # automatic snapshot. # # Constraints: # # * This parameter cannot be defined together with the `restore date` # parameter. The `use latest restorable auto snapshot` and `restore # date` parameters are mutually exclusive. # # * Define this parameter only when creating a new instance from an # automatic snapshot. For more information, see the [Amazon # Lightsail Developer Guide][1]. # # # # [1]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-automatic-snapshots # @return [Boolean] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateInstancesFromSnapshotRequest AWS API Documentation # class CreateInstancesFromSnapshotRequest < Struct.new( :instance_names, :attached_disk_mapping, :availability_zone, :instance_snapshot_name, :bundle_id, :user_data, :key_pair_name, :tags, :add_ons, :ip_address_type, :source_instance_name, :restore_date, :use_latest_restorable_auto_snapshot) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] operations # An array of objects that describe the result of the action, such as # the status of the request, the timestamp of the request, and the # resources affected by the request. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateInstancesFromSnapshotResult AWS API Documentation # class CreateInstancesFromSnapshotResult < Struct.new( :operations) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass CreateInstancesRequest # data as a hash: # # { # instance_names: ["string"], # required # availability_zone: "string", # required # custom_image_name: "ResourceName", # blueprint_id: "NonEmptyString", # required # bundle_id: "NonEmptyString", # required # user_data: "string", # key_pair_name: "ResourceName", # tags: [ # { # key: "TagKey", # value: "TagValue", # }, # ], # add_ons: [ # { # add_on_type: "AutoSnapshot", # required, accepts AutoSnapshot # auto_snapshot_add_on_request: { # snapshot_time_of_day: "TimeOfDay", # }, # }, # ], # ip_address_type: "dualstack", # accepts dualstack, ipv4 # } # # @!attribute [rw] instance_names # The names to use for your new Lightsail instances. Separate multiple # values using quotation marks and commas, for example: # `["MyFirstInstance","MySecondInstance"]` # @return [Array] # # @!attribute [rw] availability_zone # The Availability Zone in which to create your instance. Use the # following format: `us-east-2a` (case sensitive). You can get a list # of Availability Zones by using the [get regions][1] operation. Be # sure to add the `include Availability Zones` parameter to your # request. # # # # [1]: http://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetRegions.html # @return [String] # # @!attribute [rw] custom_image_name # (Deprecated) The name for your custom image. # # In releases prior to June 12, 2017, this parameter was ignored by # the API. It is now deprecated. # # # @return [String] # # @!attribute [rw] blueprint_id # The ID for a virtual private server image (e.g., `app_wordpress_4_4` # or `app_lamp_7_0`). Use the `get blueprints` operation to return a # list of available images (or *blueprints*). # # Use active blueprints when creating new instances. Inactive # blueprints are listed to support customers with existing instances # and are not necessarily available to create new instances. # Blueprints are marked inactive when they become outdated due to # operating system updates or new application releases. # # # @return [String] # # @!attribute [rw] bundle_id # The bundle of specification information for your virtual private # server (or *instance*), including the pricing plan (e.g., # `micro_1_0`). # @return [String] # # @!attribute [rw] user_data # A launch script you can create that configures a server with # additional user data. For example, you might want to run `apt-get -y # update`. # # Depending on the machine image you choose, the command to get # software on your instance varies. Amazon Linux and CentOS use `yum`, # Debian and Ubuntu use `apt-get`, and FreeBSD uses `pkg`. For a # complete list, see the [Amazon Lightsail Developer Guide][1]. # # # # # # [1]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/compare-options-choose-lightsail-instance-image # @return [String] # # @!attribute [rw] key_pair_name # The name of your key pair. # @return [String] # # @!attribute [rw] tags # The tag keys and optional values to add to the resource during # create. # # Use the `TagResource` action to tag a resource after it's created. # @return [Array] # # @!attribute [rw] add_ons # An array of objects representing the add-ons to enable for the new # instance. # @return [Array] # # @!attribute [rw] ip_address_type # The IP address type for the instance. # # The possible values are `ipv4` for IPv4 only, and `dualstack` for # IPv4 and IPv6. # # The default value is `dualstack`. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateInstancesRequest AWS API Documentation # class CreateInstancesRequest < Struct.new( :instance_names, :availability_zone, :custom_image_name, :blueprint_id, :bundle_id, :user_data, :key_pair_name, :tags, :add_ons, :ip_address_type) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] operations # An array of objects that describe the result of the action, such as # the status of the request, the timestamp of the request, and the # resources affected by the request. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateInstancesResult AWS API Documentation # class CreateInstancesResult < Struct.new( :operations) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass CreateKeyPairRequest # data as a hash: # # { # key_pair_name: "ResourceName", # required # tags: [ # { # key: "TagKey", # value: "TagValue", # }, # ], # } # # @!attribute [rw] key_pair_name # The name for your new key pair. # @return [String] # # @!attribute [rw] tags # The tag keys and optional values to add to the resource during # create. # # Use the `TagResource` action to tag a resource after it's created. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateKeyPairRequest AWS API Documentation # class CreateKeyPairRequest < Struct.new( :key_pair_name, :tags) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] key_pair # An array of key-value pairs containing information about the new key # pair you just created. # @return [Types::KeyPair] # # @!attribute [rw] public_key_base_64 # A base64-encoded public key of the `ssh-rsa` type. # @return [String] # # @!attribute [rw] private_key_base_64 # A base64-encoded RSA private key. # @return [String] # # @!attribute [rw] operation # An array of objects that describe the result of the action, such as # the status of the request, the timestamp of the request, and the # resources affected by the request. # @return [Types::Operation] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateKeyPairResult AWS API Documentation # class CreateKeyPairResult < Struct.new( :key_pair, :public_key_base_64, :private_key_base_64, :operation) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass CreateLoadBalancerRequest # data as a hash: # # { # load_balancer_name: "ResourceName", # required # instance_port: 1, # required # health_check_path: "string", # certificate_name: "ResourceName", # certificate_domain_name: "DomainName", # certificate_alternative_names: ["DomainName"], # tags: [ # { # key: "TagKey", # value: "TagValue", # }, # ], # ip_address_type: "dualstack", # accepts dualstack, ipv4 # } # # @!attribute [rw] load_balancer_name # The name of your load balancer. # @return [String] # # @!attribute [rw] instance_port # The instance port where you're creating your load balancer. # @return [Integer] # # @!attribute [rw] health_check_path # The path you provided to perform the load balancer health check. If # you didn't specify a health check path, Lightsail uses the root # path of your website (e.g., `"/"`). # # You may want to specify a custom health check path other than the # root of your application if your home page loads slowly or has a lot # of media or scripting on it. # @return [String] # # @!attribute [rw] certificate_name # The name of the SSL/TLS certificate. # # If you specify `certificateName`, then `certificateDomainName` is # required (and vice-versa). # @return [String] # # @!attribute [rw] certificate_domain_name # The domain name with which your certificate is associated (e.g., # `example.com`). # # If you specify `certificateDomainName`, then `certificateName` is # required (and vice-versa). # @return [String] # # @!attribute [rw] certificate_alternative_names # The optional alternative domains and subdomains to use with your # SSL/TLS certificate (e.g., `www.example.com`, `example.com`, # `m.example.com`, `blog.example.com`). # @return [Array] # # @!attribute [rw] tags # The tag keys and optional values to add to the resource during # create. # # Use the `TagResource` action to tag a resource after it's created. # @return [Array] # # @!attribute [rw] ip_address_type # The IP address type for the load balancer. # # The possible values are `ipv4` for IPv4 only, and `dualstack` for # IPv4 and IPv6. # # The default value is `dualstack`. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateLoadBalancerRequest AWS API Documentation # class CreateLoadBalancerRequest < Struct.new( :load_balancer_name, :instance_port, :health_check_path, :certificate_name, :certificate_domain_name, :certificate_alternative_names, :tags, :ip_address_type) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] operations # An array of objects that describe the result of the action, such as # the status of the request, the timestamp of the request, and the # resources affected by the request. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateLoadBalancerResult AWS API Documentation # class CreateLoadBalancerResult < Struct.new( :operations) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass CreateLoadBalancerTlsCertificateRequest # data as a hash: # # { # load_balancer_name: "ResourceName", # required # certificate_name: "ResourceName", # required # certificate_domain_name: "DomainName", # required # certificate_alternative_names: ["DomainName"], # tags: [ # { # key: "TagKey", # value: "TagValue", # }, # ], # } # # @!attribute [rw] load_balancer_name # The load balancer name where you want to create the SSL/TLS # certificate. # @return [String] # # @!attribute [rw] certificate_name # The SSL/TLS certificate name. # # You can have up to 10 certificates in your account at one time. Each # Lightsail load balancer can have up to 2 certificates associated # with it at one time. There is also an overall limit to the number of # certificates that can be issue in a 365-day period. For more # information, see [Limits][1]. # # # # [1]: http://docs.aws.amazon.com/acm/latest/userguide/acm-limits.html # @return [String] # # @!attribute [rw] certificate_domain_name # The domain name (e.g., `example.com`) for your SSL/TLS certificate. # @return [String] # # @!attribute [rw] certificate_alternative_names # An array of strings listing alternative domains and subdomains for # your SSL/TLS certificate. Lightsail will de-dupe the names for you. # You can have a maximum of 9 alternative names (in addition to the 1 # primary domain). We do not support wildcards (e.g., # `*.example.com`). # @return [Array] # # @!attribute [rw] tags # The tag keys and optional values to add to the resource during # create. # # Use the `TagResource` action to tag a resource after it's created. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateLoadBalancerTlsCertificateRequest AWS API Documentation # class CreateLoadBalancerTlsCertificateRequest < Struct.new( :load_balancer_name, :certificate_name, :certificate_domain_name, :certificate_alternative_names, :tags) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] operations # An array of objects that describe the result of the action, such as # the status of the request, the timestamp of the request, and the # resources affected by the request. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateLoadBalancerTlsCertificateResult AWS API Documentation # class CreateLoadBalancerTlsCertificateResult < Struct.new( :operations) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass CreateRelationalDatabaseFromSnapshotRequest # data as a hash: # # { # relational_database_name: "ResourceName", # required # availability_zone: "string", # publicly_accessible: false, # relational_database_snapshot_name: "ResourceName", # relational_database_bundle_id: "string", # source_relational_database_name: "ResourceName", # restore_time: Time.now, # use_latest_restorable_time: false, # tags: [ # { # key: "TagKey", # value: "TagValue", # }, # ], # } # # @!attribute [rw] relational_database_name # The name to use for your new Lightsail database resource. # # Constraints: # # * Must contain from 2 to 255 alphanumeric characters, or hyphens. # # * The first and last character must be a letter or number. # @return [String] # # @!attribute [rw] availability_zone # The Availability Zone in which to create your new database. Use the # `us-east-2a` case-sensitive format. # # You can get a list of Availability Zones by using the `get regions` # operation. Be sure to add the `include relational database # Availability Zones` parameter to your request. # @return [String] # # @!attribute [rw] publicly_accessible # Specifies the accessibility options for your new database. A value # of `true` specifies a database that is available to resources # outside of your Lightsail account. A value of `false` specifies a # database that is available only to your Lightsail resources in the # same region as your database. # @return [Boolean] # # @!attribute [rw] relational_database_snapshot_name # The name of the database snapshot from which to create your new # database. # @return [String] # # @!attribute [rw] relational_database_bundle_id # The bundle ID for your new database. A bundle describes the # performance specifications for your database. # # You can get a list of database bundle IDs by using the `get # relational database bundles` operation. # # When creating a new database from a snapshot, you cannot choose a # bundle that is smaller than the bundle of the source database. # @return [String] # # @!attribute [rw] source_relational_database_name # The name of the source database. # @return [String] # # @!attribute [rw] restore_time # The date and time to restore your database from. # # Constraints: # # * Must be before the latest restorable time for the database. # # * Cannot be specified if the `use latest restorable time` parameter # is `true`. # # * Specified in Coordinated Universal Time (UTC). # # * Specified in the Unix time format. # # For example, if you wish to use a restore time of October 1, 2018, # at 8 PM UTC, then you input `1538424000` as the restore time. # @return [Time] # # @!attribute [rw] use_latest_restorable_time # Specifies whether your database is restored from the latest backup # time. A value of `true` restores from the latest backup time. # # Default: `false` # # Constraints: Cannot be specified if the `restore time` parameter is # provided. # @return [Boolean] # # @!attribute [rw] tags # The tag keys and optional values to add to the resource during # create. # # Use the `TagResource` action to tag a resource after it's created. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateRelationalDatabaseFromSnapshotRequest AWS API Documentation # class CreateRelationalDatabaseFromSnapshotRequest < Struct.new( :relational_database_name, :availability_zone, :publicly_accessible, :relational_database_snapshot_name, :relational_database_bundle_id, :source_relational_database_name, :restore_time, :use_latest_restorable_time, :tags) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] operations # An array of objects that describe the result of the action, such as # the status of the request, the timestamp of the request, and the # resources affected by the request. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateRelationalDatabaseFromSnapshotResult AWS API Documentation # class CreateRelationalDatabaseFromSnapshotResult < Struct.new( :operations) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass CreateRelationalDatabaseRequest # data as a hash: # # { # relational_database_name: "ResourceName", # required # availability_zone: "string", # relational_database_blueprint_id: "string", # required # relational_database_bundle_id: "string", # required # master_database_name: "string", # required # master_username: "string", # required # master_user_password: "SensitiveString", # preferred_backup_window: "string", # preferred_maintenance_window: "string", # publicly_accessible: false, # tags: [ # { # key: "TagKey", # value: "TagValue", # }, # ], # } # # @!attribute [rw] relational_database_name # The name to use for your new Lightsail database resource. # # Constraints: # # * Must contain from 2 to 255 alphanumeric characters, or hyphens. # # * The first and last character must be a letter or number. # @return [String] # # @!attribute [rw] availability_zone # The Availability Zone in which to create your new database. Use the # `us-east-2a` case-sensitive format. # # You can get a list of Availability Zones by using the `get regions` # operation. Be sure to add the `include relational database # Availability Zones` parameter to your request. # @return [String] # # @!attribute [rw] relational_database_blueprint_id # The blueprint ID for your new database. A blueprint describes the # major engine version of a database. # # You can get a list of database blueprints IDs by using the `get # relational database blueprints` operation. # @return [String] # # @!attribute [rw] relational_database_bundle_id # The bundle ID for your new database. A bundle describes the # performance specifications for your database. # # You can get a list of database bundle IDs by using the `get # relational database bundles` operation. # @return [String] # # @!attribute [rw] master_database_name # The meaning of this parameter differs according to the database # engine you use. # # **MySQL** # # The name of the database to create when the Lightsail database # resource is created. If this parameter isn't specified, no database # is created in the database resource. # # Constraints: # # * Must contain 1 to 64 letters or numbers. # # * Must begin with a letter. Subsequent characters can be letters, # underscores, or digits (0- 9). # # * Can't be a word reserved by the specified database engine. # # For more information about reserved words in MySQL, see the # Keywords and Reserved Words articles for [MySQL 5.6][1], [MySQL # 5.7][2], and [MySQL 8.0][3]. # # **PostgreSQL** # # The name of the database to create when the Lightsail database # resource is created. If this parameter isn't specified, a database # named `postgres` is created in the database resource. # # Constraints: # # * Must contain 1 to 63 letters or numbers. # # * Must begin with a letter. Subsequent characters can be letters, # underscores, or digits (0- 9). # # * Can't be a word reserved by the specified database engine. # # For more information about reserved words in PostgreSQL, see the # SQL Key Words articles for [PostgreSQL 9.6][4], [PostgreSQL # 10][5], [PostgreSQL 11][6], and [PostgreSQL 12][7]. # # # # [1]: https://dev.mysql.com/doc/refman/5.6/en/keywords.html # [2]: https://dev.mysql.com/doc/refman/5.7/en/keywords.html # [3]: https://dev.mysql.com/doc/refman/8.0/en/keywords.html # [4]: https://www.postgresql.org/docs/9.6/sql-keywords-appendix.html # [5]: https://www.postgresql.org/docs/10/sql-keywords-appendix.html # [6]: https://www.postgresql.org/docs/11/sql-keywords-appendix.html # [7]: https://www.postgresql.org/docs/12/sql-keywords-appendix.html # @return [String] # # @!attribute [rw] master_username # The name for the master user. # # **MySQL** # # Constraints: # # * Required for MySQL. # # * Must be 1 to 16 letters or numbers. Can contain underscores. # # * First character must be a letter. # # * Can't be a reserved word for the chosen database engine. # # For more information about reserved words in MySQL 5.6 or 5.7, see # the Keywords and Reserved Words articles for [MySQL 5.6][1], # [MySQL 5.7][2], or [MySQL 8.0][3]. # # **PostgreSQL** # # Constraints: # # * Required for PostgreSQL. # # * Must be 1 to 63 letters or numbers. Can contain underscores. # # * First character must be a letter. # # * Can't be a reserved word for the chosen database engine. # # For more information about reserved words in MySQL 5.6 or 5.7, see # the Keywords and Reserved Words articles for [PostgreSQL 9.6][4], # [PostgreSQL 10][5], [PostgreSQL 11][6], and [PostgreSQL 12][7]. # # # # [1]: https://dev.mysql.com/doc/refman/5.6/en/keywords.html # [2]: https://dev.mysql.com/doc/refman/5.7/en/keywords.html # [3]: https://dev.mysql.com/doc/refman/8.0/en/keywords.html # [4]: https://www.postgresql.org/docs/9.6/sql-keywords-appendix.html # [5]: https://www.postgresql.org/docs/10/sql-keywords-appendix.html # [6]: https://www.postgresql.org/docs/11/sql-keywords-appendix.html # [7]: https://www.postgresql.org/docs/12/sql-keywords-appendix.html # @return [String] # # @!attribute [rw] master_user_password # The password for the master user. The password can include any # printable ASCII character except "/", """, or "@". It cannot # contain spaces. # # **MySQL** # # Constraints: Must contain from 8 to 41 characters. # # **PostgreSQL** # # Constraints: Must contain from 8 to 128 characters. # @return [String] # # @!attribute [rw] preferred_backup_window # The daily time range during which automated backups are created for # your new database if automated backups are enabled. # # The default is a 30-minute window selected at random from an 8-hour # block of time for each AWS Region. For more information about the # preferred backup window time blocks for each region, see the # [Working With Backups][1] guide in the Amazon Relational Database # Service (Amazon RDS) documentation. # # Constraints: # # * Must be in the `hh24:mi-hh24:mi` format. # # Example: `16:00-16:30` # # * Specified in Coordinated Universal Time (UTC). # # * Must not conflict with the preferred maintenance window. # # * Must be at least 30 minutes. # # # # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow # @return [String] # # @!attribute [rw] preferred_maintenance_window # The weekly time range during which system maintenance can occur on # your new database. # # The default is a 30-minute window selected at random from an 8-hour # block of time for each AWS Region, occurring on a random day of the # week. # # Constraints: # # * Must be in the `ddd:hh24:mi-ddd:hh24:mi` format. # # * Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun. # # * Must be at least 30 minutes. # # * Specified in Coordinated Universal Time (UTC). # # * Example: `Tue:17:00-Tue:17:30` # @return [String] # # @!attribute [rw] publicly_accessible # Specifies the accessibility options for your new database. A value # of `true` specifies a database that is available to resources # outside of your Lightsail account. A value of `false` specifies a # database that is available only to your Lightsail resources in the # same region as your database. # @return [Boolean] # # @!attribute [rw] tags # The tag keys and optional values to add to the resource during # create. # # Use the `TagResource` action to tag a resource after it's created. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateRelationalDatabaseRequest AWS API Documentation # class CreateRelationalDatabaseRequest < Struct.new( :relational_database_name, :availability_zone, :relational_database_blueprint_id, :relational_database_bundle_id, :master_database_name, :master_username, :master_user_password, :preferred_backup_window, :preferred_maintenance_window, :publicly_accessible, :tags) SENSITIVE = [:master_user_password] include Aws::Structure end # @!attribute [rw] operations # An array of objects that describe the result of the action, such as # the status of the request, the timestamp of the request, and the # resources affected by the request. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateRelationalDatabaseResult AWS API Documentation # class CreateRelationalDatabaseResult < Struct.new( :operations) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass CreateRelationalDatabaseSnapshotRequest # data as a hash: # # { # relational_database_name: "ResourceName", # required # relational_database_snapshot_name: "ResourceName", # required # tags: [ # { # key: "TagKey", # value: "TagValue", # }, # ], # } # # @!attribute [rw] relational_database_name # The name of the database on which to base your new snapshot. # @return [String] # # @!attribute [rw] relational_database_snapshot_name # The name for your new database snapshot. # # Constraints: # # * Must contain from 2 to 255 alphanumeric characters, or hyphens. # # * The first and last character must be a letter or number. # @return [String] # # @!attribute [rw] tags # The tag keys and optional values to add to the resource during # create. # # Use the `TagResource` action to tag a resource after it's created. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateRelationalDatabaseSnapshotRequest AWS API Documentation # class CreateRelationalDatabaseSnapshotRequest < Struct.new( :relational_database_name, :relational_database_snapshot_name, :tags) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] operations # An array of objects that describe the result of the action, such as # the status of the request, the timestamp of the request, and the # resources affected by the request. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateRelationalDatabaseSnapshotResult AWS API Documentation # class CreateRelationalDatabaseSnapshotResult < Struct.new( :operations) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass DeleteAlarmRequest # data as a hash: # # { # alarm_name: "ResourceName", # required # } # # @!attribute [rw] alarm_name # The name of the alarm to delete. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteAlarmRequest AWS API Documentation # class DeleteAlarmRequest < Struct.new( :alarm_name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] operations # An array of objects that describe the result of the action, such as # the status of the request, the timestamp of the request, and the # resources affected by the request. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteAlarmResult AWS API Documentation # class DeleteAlarmResult < Struct.new( :operations) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass DeleteAutoSnapshotRequest # data as a hash: # # { # resource_name: "ResourceName", # required # date: "AutoSnapshotDate", # required # } # # @!attribute [rw] resource_name # The name of the source instance or disk from which to delete the # automatic snapshot. # @return [String] # # @!attribute [rw] date # The date of the automatic snapshot to delete in `YYYY-MM-DD` format. # Use the `get auto snapshots` operation to get the available # automatic snapshots for a resource. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteAutoSnapshotRequest AWS API Documentation # class DeleteAutoSnapshotRequest < Struct.new( :resource_name, :date) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] operations # An array of objects that describe the result of the action, such as # the status of the request, the timestamp of the request, and the # resources affected by the request. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteAutoSnapshotResult AWS API Documentation # class DeleteAutoSnapshotResult < Struct.new( :operations) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass DeleteBucketAccessKeyRequest # data as a hash: # # { # bucket_name: "BucketName", # required # access_key_id: "NonEmptyString", # required # } # # @!attribute [rw] bucket_name # The name of the bucket that the access key belongs to. # @return [String] # # @!attribute [rw] access_key_id # The ID of the access key to delete. # # Use the GetBucketAccessKeys action to get a list of access key IDs # that you can specify. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteBucketAccessKeyRequest AWS API Documentation # class DeleteBucketAccessKeyRequest < Struct.new( :bucket_name, :access_key_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] operations # An array of objects that describe the result of the action, such as # the status of the request, the timestamp of the request, and the # resources affected by the request. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteBucketAccessKeyResult AWS API Documentation # class DeleteBucketAccessKeyResult < Struct.new( :operations) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass DeleteBucketRequest # data as a hash: # # { # bucket_name: "BucketName", # required # force_delete: false, # } # # @!attribute [rw] bucket_name # The name of the bucket to delete. # # Use the GetBuckets action to get a list of bucket names that you can # specify. # @return [String] # # @!attribute [rw] force_delete # A Boolean value that indicates whether to force delete the bucket. # # You must force delete the bucket if it has one of the following # conditions: # # * The bucket is the origin of a distribution. # # * The bucket has instances that were granted access to it using the # SetResourceAccessForBucket action. # # * The bucket has objects. # # * The bucket has access keys. # # Force deleting a bucket might impact other resources that rely on # the bucket, such as instances, distributions, or software that use # the issued access keys. # @return [Boolean] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteBucketRequest AWS API Documentation # class DeleteBucketRequest < Struct.new( :bucket_name, :force_delete) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] operations # An array of objects that describe the result of the action, such as # the status of the request, the timestamp of the request, and the # resources affected by the request. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteBucketResult AWS API Documentation # class DeleteBucketResult < Struct.new( :operations) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass DeleteCertificateRequest # data as a hash: # # { # certificate_name: "CertificateName", # required # } # # @!attribute [rw] certificate_name # The name of the certificate to delete. # # Use the `GetCertificates` action to get a list of certificate names # that you can specify. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteCertificateRequest AWS API Documentation # class DeleteCertificateRequest < Struct.new( :certificate_name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] operations # An array of objects that describe the result of the action, such as # the status of the request, the timestamp of the request, and the # resources affected by the request. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteCertificateResult AWS API Documentation # class DeleteCertificateResult < Struct.new( :operations) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass DeleteContactMethodRequest # data as a hash: # # { # protocol: "Email", # required, accepts Email, SMS # } # # @!attribute [rw] protocol # The protocol that will be deleted, such as `Email` or `SMS` (text # messaging). # # To delete an `Email` and an `SMS` contact method if you added both, # you must run separate `DeleteContactMethod` actions to delete each # protocol. # # # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteContactMethodRequest AWS API Documentation # class DeleteContactMethodRequest < Struct.new( :protocol) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] operations # An array of objects that describe the result of the action, such as # the status of the request, the timestamp of the request, and the # resources affected by the request. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteContactMethodResult AWS API Documentation # class DeleteContactMethodResult < Struct.new( :operations) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass DeleteContainerImageRequest # data as a hash: # # { # service_name: "ContainerServiceName", # required # image: "string", # required # } # # @!attribute [rw] service_name # The name of the container service for which to delete a registered # container image. # @return [String] # # @!attribute [rw] image # The name of the container image to delete from the container # service. # # Use the `GetContainerImages` action to get the name of the container # images that are registered to a container service. # # Container images sourced from your Lightsail container service, that # are registered and stored on your service, start with a colon (`:`). # For example, `:container-service-1.mystaticwebsite.1`. Container # images sourced from a public registry like Docker Hub don't start # with a colon. For example, `nginx:latest` or `nginx`. # # # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteContainerImageRequest AWS API Documentation # class DeleteContainerImageRequest < Struct.new( :service_name, :image) SENSITIVE = [] include Aws::Structure end # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteContainerImageResult AWS API Documentation # class DeleteContainerImageResult < Aws::EmptyStructure; end # @note When making an API call, you may pass DeleteContainerServiceRequest # data as a hash: # # { # service_name: "ContainerServiceName", # required # } # # @!attribute [rw] service_name # The name of the container service to delete. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteContainerServiceRequest AWS API Documentation # class DeleteContainerServiceRequest < Struct.new( :service_name) SENSITIVE = [] include Aws::Structure end # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteContainerServiceResult AWS API Documentation # class DeleteContainerServiceResult < Aws::EmptyStructure; end # @note When making an API call, you may pass DeleteDiskRequest # data as a hash: # # { # disk_name: "ResourceName", # required # force_delete_add_ons: false, # } # # @!attribute [rw] disk_name # The unique name of the disk you want to delete (e.g., `my-disk`). # @return [String] # # @!attribute [rw] force_delete_add_ons # A Boolean value to indicate whether to delete the enabled add-ons # for the disk. # @return [Boolean] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteDiskRequest AWS API Documentation # class DeleteDiskRequest < Struct.new( :disk_name, :force_delete_add_ons) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] operations # An array of objects that describe the result of the action, such as # the status of the request, the timestamp of the request, and the # resources affected by the request. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteDiskResult AWS API Documentation # class DeleteDiskResult < Struct.new( :operations) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass DeleteDiskSnapshotRequest # data as a hash: # # { # disk_snapshot_name: "ResourceName", # required # } # # @!attribute [rw] disk_snapshot_name # The name of the disk snapshot you want to delete (e.g., # `my-disk-snapshot`). # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteDiskSnapshotRequest AWS API Documentation # class DeleteDiskSnapshotRequest < Struct.new( :disk_snapshot_name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] operations # An array of objects that describe the result of the action, such as # the status of the request, the timestamp of the request, and the # resources affected by the request. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteDiskSnapshotResult AWS API Documentation # class DeleteDiskSnapshotResult < Struct.new( :operations) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass DeleteDistributionRequest # data as a hash: # # { # distribution_name: "ResourceName", # } # # @!attribute [rw] distribution_name # The name of the distribution to delete. # # Use the `GetDistributions` action to get a list of distribution # names that you can specify. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteDistributionRequest AWS API Documentation # class DeleteDistributionRequest < Struct.new( :distribution_name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] operation # An object that describes the result of the action, such as the # status of the request, the timestamp of the request, and the # resources affected by the request. # @return [Types::Operation] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteDistributionResult AWS API Documentation # class DeleteDistributionResult < Struct.new( :operation) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass DeleteDomainEntryRequest # data as a hash: # # { # domain_name: "DomainName", # required # domain_entry: { # required # id: "NonEmptyString", # name: "DomainName", # target: "string", # is_alias: false, # type: "DomainEntryType", # options: { # "DomainEntryOptionsKeys" => "string", # }, # }, # } # # @!attribute [rw] domain_name # The name of the domain entry to delete. # @return [String] # # @!attribute [rw] domain_entry # An array of key-value pairs containing information about your domain # entries. # @return [Types::DomainEntry] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteDomainEntryRequest AWS API Documentation # class DeleteDomainEntryRequest < Struct.new( :domain_name, :domain_entry) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] operation # An array of objects that describe the result of the action, such as # the status of the request, the timestamp of the request, and the # resources affected by the request. # @return [Types::Operation] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteDomainEntryResult AWS API Documentation # class DeleteDomainEntryResult < Struct.new( :operation) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass DeleteDomainRequest # data as a hash: # # { # domain_name: "DomainName", # required # } # # @!attribute [rw] domain_name # The specific domain name to delete. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteDomainRequest AWS API Documentation # class DeleteDomainRequest < Struct.new( :domain_name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] operation # An array of objects that describe the result of the action, such as # the status of the request, the timestamp of the request, and the # resources affected by the request. # @return [Types::Operation] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteDomainResult AWS API Documentation # class DeleteDomainResult < Struct.new( :operation) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass DeleteInstanceRequest # data as a hash: # # { # instance_name: "ResourceName", # required # force_delete_add_ons: false, # } # # @!attribute [rw] instance_name # The name of the instance to delete. # @return [String] # # @!attribute [rw] force_delete_add_ons # A Boolean value to indicate whether to delete the enabled add-ons # for the disk. # @return [Boolean] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteInstanceRequest AWS API Documentation # class DeleteInstanceRequest < Struct.new( :instance_name, :force_delete_add_ons) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] operations # An array of objects that describe the result of the action, such as # the status of the request, the timestamp of the request, and the # resources affected by the request. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteInstanceResult AWS API Documentation # class DeleteInstanceResult < Struct.new( :operations) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass DeleteInstanceSnapshotRequest # data as a hash: # # { # instance_snapshot_name: "ResourceName", # required # } # # @!attribute [rw] instance_snapshot_name # The name of the snapshot to delete. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteInstanceSnapshotRequest AWS API Documentation # class DeleteInstanceSnapshotRequest < Struct.new( :instance_snapshot_name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] operations # An array of objects that describe the result of the action, such as # the status of the request, the timestamp of the request, and the # resources affected by the request. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteInstanceSnapshotResult AWS API Documentation # class DeleteInstanceSnapshotResult < Struct.new( :operations) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass DeleteKeyPairRequest # data as a hash: # # { # key_pair_name: "ResourceName", # required # } # # @!attribute [rw] key_pair_name # The name of the key pair to delete. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteKeyPairRequest AWS API Documentation # class DeleteKeyPairRequest < Struct.new( :key_pair_name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] operation # An array of objects that describe the result of the action, such as # the status of the request, the timestamp of the request, and the # resources affected by the request. # @return [Types::Operation] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteKeyPairResult AWS API Documentation # class DeleteKeyPairResult < Struct.new( :operation) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass DeleteKnownHostKeysRequest # data as a hash: # # { # instance_name: "ResourceName", # required # } # # @!attribute [rw] instance_name # The name of the instance for which you want to reset the host key or # certificate. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteKnownHostKeysRequest AWS API Documentation # class DeleteKnownHostKeysRequest < Struct.new( :instance_name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] operations # An array of objects that describe the result of the action, such as # the status of the request, the timestamp of the request, and the # resources affected by the request. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteKnownHostKeysResult AWS API Documentation # class DeleteKnownHostKeysResult < Struct.new( :operations) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass DeleteLoadBalancerRequest # data as a hash: # # { # load_balancer_name: "ResourceName", # required # } # # @!attribute [rw] load_balancer_name # The name of the load balancer you want to delete. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteLoadBalancerRequest AWS API Documentation # class DeleteLoadBalancerRequest < Struct.new( :load_balancer_name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] operations # An array of objects that describe the result of the action, such as # the status of the request, the timestamp of the request, and the # resources affected by the request. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteLoadBalancerResult AWS API Documentation # class DeleteLoadBalancerResult < Struct.new( :operations) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass DeleteLoadBalancerTlsCertificateRequest # data as a hash: # # { # load_balancer_name: "ResourceName", # required # certificate_name: "ResourceName", # required # force: false, # } # # @!attribute [rw] load_balancer_name # The load balancer name. # @return [String] # # @!attribute [rw] certificate_name # The SSL/TLS certificate name. # @return [String] # # @!attribute [rw] force # When `true`, forces the deletion of an SSL/TLS certificate. # # There can be two certificates associated with a Lightsail load # balancer: the primary and the backup. The `force` parameter is # required when the primary SSL/TLS certificate is in use by an # instance attached to the load balancer. # @return [Boolean] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteLoadBalancerTlsCertificateRequest AWS API Documentation # class DeleteLoadBalancerTlsCertificateRequest < Struct.new( :load_balancer_name, :certificate_name, :force) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] operations # An array of objects that describe the result of the action, such as # the status of the request, the timestamp of the request, and the # resources affected by the request. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteLoadBalancerTlsCertificateResult AWS API Documentation # class DeleteLoadBalancerTlsCertificateResult < Struct.new( :operations) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass DeleteRelationalDatabaseRequest # data as a hash: # # { # relational_database_name: "ResourceName", # required # skip_final_snapshot: false, # final_relational_database_snapshot_name: "ResourceName", # } # # @!attribute [rw] relational_database_name # The name of the database that you are deleting. # @return [String] # # @!attribute [rw] skip_final_snapshot # Determines whether a final database snapshot is created before your # database is deleted. If `true` is specified, no database snapshot is # created. If `false` is specified, a database snapshot is created # before your database is deleted. # # You must specify the `final relational database snapshot name` # parameter if the `skip final snapshot` parameter is `false`. # # Default: `false` # @return [Boolean] # # @!attribute [rw] final_relational_database_snapshot_name # The name of the database snapshot created if `skip final snapshot` # is `false`, which is the default value for that parameter. # # Specifying this parameter and also specifying the `skip final # snapshot` parameter to `true` results in an error. # # # # Constraints: # # * Must contain from 2 to 255 alphanumeric characters, or hyphens. # # * The first and last character must be a letter or number. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteRelationalDatabaseRequest AWS API Documentation # class DeleteRelationalDatabaseRequest < Struct.new( :relational_database_name, :skip_final_snapshot, :final_relational_database_snapshot_name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] operations # An array of objects that describe the result of the action, such as # the status of the request, the timestamp of the request, and the # resources affected by the request. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteRelationalDatabaseResult AWS API Documentation # class DeleteRelationalDatabaseResult < Struct.new( :operations) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass DeleteRelationalDatabaseSnapshotRequest # data as a hash: # # { # relational_database_snapshot_name: "ResourceName", # required # } # # @!attribute [rw] relational_database_snapshot_name # The name of the database snapshot that you are deleting. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteRelationalDatabaseSnapshotRequest AWS API Documentation # class DeleteRelationalDatabaseSnapshotRequest < Struct.new( :relational_database_snapshot_name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] operations # An array of objects that describe the result of the action, such as # the status of the request, the timestamp of the request, and the # resources affected by the request. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteRelationalDatabaseSnapshotResult AWS API Documentation # class DeleteRelationalDatabaseSnapshotResult < Struct.new( :operations) SENSITIVE = [] include Aws::Structure end # Describes the destination of a record. # # @!attribute [rw] id # The ID of the resource created at the destination. # @return [String] # # @!attribute [rw] service # The destination service of the record. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DestinationInfo AWS API Documentation # class DestinationInfo < Struct.new( :id, :service) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass DetachCertificateFromDistributionRequest # data as a hash: # # { # distribution_name: "ResourceName", # required # } # # @!attribute [rw] distribution_name # The name of the distribution from which to detach the certificate. # # Use the `GetDistributions` action to get a list of distribution # names that you can specify. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DetachCertificateFromDistributionRequest AWS API Documentation # class DetachCertificateFromDistributionRequest < Struct.new( :distribution_name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] operation # An object that describes the result of the action, such as the # status of the request, the timestamp of the request, and the # resources affected by the request. # @return [Types::Operation] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DetachCertificateFromDistributionResult AWS API Documentation # class DetachCertificateFromDistributionResult < Struct.new( :operation) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass DetachDiskRequest # data as a hash: # # { # disk_name: "ResourceName", # required # } # # @!attribute [rw] disk_name # The unique name of the disk you want to detach from your instance # (e.g., `my-disk`). # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DetachDiskRequest AWS API Documentation # class DetachDiskRequest < Struct.new( :disk_name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] operations # An array of objects that describe the result of the action, such as # the status of the request, the timestamp of the request, and the # resources affected by the request. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DetachDiskResult AWS API Documentation # class DetachDiskResult < Struct.new( :operations) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass DetachInstancesFromLoadBalancerRequest # data as a hash: # # { # load_balancer_name: "ResourceName", # required # instance_names: ["ResourceName"], # required # } # # @!attribute [rw] load_balancer_name # The name of the Lightsail load balancer. # @return [String] # # @!attribute [rw] instance_names # An array of strings containing the names of the instances you want # to detach from the load balancer. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DetachInstancesFromLoadBalancerRequest AWS API Documentation # class DetachInstancesFromLoadBalancerRequest < Struct.new( :load_balancer_name, :instance_names) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] operations # An array of objects that describe the result of the action, such as # the status of the request, the timestamp of the request, and the # resources affected by the request. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DetachInstancesFromLoadBalancerResult AWS API Documentation # class DetachInstancesFromLoadBalancerResult < Struct.new( :operations) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass DetachStaticIpRequest # data as a hash: # # { # static_ip_name: "ResourceName", # required # } # # @!attribute [rw] static_ip_name # The name of the static IP to detach from the instance. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DetachStaticIpRequest AWS API Documentation # class DetachStaticIpRequest < Struct.new( :static_ip_name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] operations # An array of objects that describe the result of the action, such as # the status of the request, the timestamp of the request, and the # resources affected by the request. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DetachStaticIpResult AWS API Documentation # class DetachStaticIpResult < Struct.new( :operations) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass DisableAddOnRequest # data as a hash: # # { # add_on_type: "AutoSnapshot", # required, accepts AutoSnapshot # resource_name: "ResourceName", # required # } # # @!attribute [rw] add_on_type # The add-on type to disable. # @return [String] # # @!attribute [rw] resource_name # The name of the source resource for which to disable the add-on. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DisableAddOnRequest AWS API Documentation # class DisableAddOnRequest < Struct.new( :add_on_type, :resource_name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] operations # An array of objects that describe the result of the action, such as # the status of the request, the timestamp of the request, and the # resources affected by the request. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DisableAddOnResult AWS API Documentation # class DisableAddOnResult < Struct.new( :operations) SENSITIVE = [] include Aws::Structure end # Describes a block storage disk. # # @!attribute [rw] name # The unique name of the disk. # @return [String] # # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the disk. # @return [String] # # @!attribute [rw] support_code # The support code. Include this code in your email to support when # you have questions about an instance or another resource in # Lightsail. This code enables our support team to look up your # Lightsail information more easily. # @return [String] # # @!attribute [rw] created_at # The date when the disk was created. # @return [Time] # # @!attribute [rw] location # The AWS Region and Availability Zone where the disk is located. # @return [Types::ResourceLocation] # # @!attribute [rw] resource_type # The Lightsail resource type (e.g., `Disk`). # @return [String] # # @!attribute [rw] tags # The tag keys and optional values for the resource. For more # information about tags in Lightsail, see the [Amazon Lightsail # Developer Guide][1]. # # # # [1]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags # @return [Array] # # @!attribute [rw] add_ons # An array of objects representing the add-ons enabled on the disk. # @return [Array] # # @!attribute [rw] size_in_gb # The size of the disk in GB. # @return [Integer] # # @!attribute [rw] is_system_disk # A Boolean value indicating whether this disk is a system disk (has # an operating system loaded on it). # @return [Boolean] # # @!attribute [rw] iops # The input/output operations per second (IOPS) of the disk. # @return [Integer] # # @!attribute [rw] path # The disk path. # @return [String] # # @!attribute [rw] state # Describes the status of the disk. # @return [String] # # @!attribute [rw] attached_to # The resources to which the disk is attached. # @return [String] # # @!attribute [rw] is_attached # A Boolean value indicating whether the disk is attached. # @return [Boolean] # # @!attribute [rw] attachment_state # (Deprecated) The attachment state of the disk. # # In releases prior to November 14, 2017, this parameter returned # `attached` for system disks in the API response. It is now # deprecated, but still included in the response. Use `isAttached` # instead. # # # @return [String] # # @!attribute [rw] gb_in_use # (Deprecated) The number of GB in use by the disk. # # In releases prior to November 14, 2017, this parameter was not # included in the API response. It is now deprecated. # # # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/Disk AWS API Documentation # class Disk < Struct.new( :name, :arn, :support_code, :created_at, :location, :resource_type, :tags, :add_ons, :size_in_gb, :is_system_disk, :iops, :path, :state, :attached_to, :is_attached, :attachment_state, :gb_in_use) SENSITIVE = [] include Aws::Structure end # Describes a disk. # # @!attribute [rw] name # The disk name. # @return [String] # # @!attribute [rw] path # The disk path. # @return [String] # # @!attribute [rw] size_in_gb # The size of the disk in GB (e.g., `32`). # @return [Integer] # # @!attribute [rw] is_system_disk # A Boolean value indicating whether this disk is a system disk (has # an operating system loaded on it). # @return [Boolean] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DiskInfo AWS API Documentation # class DiskInfo < Struct.new( :name, :path, :size_in_gb, :is_system_disk) SENSITIVE = [] include Aws::Structure end # Describes a block storage disk mapping. # # @note When making an API call, you may pass DiskMap # data as a hash: # # { # original_disk_path: "NonEmptyString", # new_disk_name: "ResourceName", # } # # @!attribute [rw] original_disk_path # The original disk path exposed to the instance (for example, # `/dev/sdh`). # @return [String] # # @!attribute [rw] new_disk_name # The new disk name (e.g., `my-new-disk`). # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DiskMap AWS API Documentation # class DiskMap < Struct.new( :original_disk_path, :new_disk_name) SENSITIVE = [] include Aws::Structure end # Describes a block storage disk snapshot. # # @!attribute [rw] name # The name of the disk snapshot (e.g., `my-disk-snapshot`). # @return [String] # # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the disk snapshot. # @return [String] # # @!attribute [rw] support_code # The support code. Include this code in your email to support when # you have questions about an instance or another resource in # Lightsail. This code enables our support team to look up your # Lightsail information more easily. # @return [String] # # @!attribute [rw] created_at # The date when the disk snapshot was created. # @return [Time] # # @!attribute [rw] location # The AWS Region and Availability Zone where the disk snapshot was # created. # @return [Types::ResourceLocation] # # @!attribute [rw] resource_type # The Lightsail resource type (e.g., `DiskSnapshot`). # @return [String] # # @!attribute [rw] tags # The tag keys and optional values for the resource. For more # information about tags in Lightsail, see the [Amazon Lightsail # Developer Guide][1]. # # # # [1]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags # @return [Array] # # @!attribute [rw] size_in_gb # The size of the disk in GB. # @return [Integer] # # @!attribute [rw] state # The status of the disk snapshot operation. # @return [String] # # @!attribute [rw] progress # The progress of the snapshot. # @return [String] # # @!attribute [rw] from_disk_name # The unique name of the source disk from which the disk snapshot was # created. # @return [String] # # @!attribute [rw] from_disk_arn # The Amazon Resource Name (ARN) of the source disk from which the # disk snapshot was created. # @return [String] # # @!attribute [rw] from_instance_name # The unique name of the source instance from which the disk (system # volume) snapshot was created. # @return [String] # # @!attribute [rw] from_instance_arn # The Amazon Resource Name (ARN) of the source instance from which the # disk (system volume) snapshot was created. # @return [String] # # @!attribute [rw] is_from_auto_snapshot # A Boolean value indicating whether the snapshot was created from an # automatic snapshot. # @return [Boolean] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DiskSnapshot AWS API Documentation # class DiskSnapshot < Struct.new( :name, :arn, :support_code, :created_at, :location, :resource_type, :tags, :size_in_gb, :state, :progress, :from_disk_name, :from_disk_arn, :from_instance_name, :from_instance_arn, :is_from_auto_snapshot) SENSITIVE = [] include Aws::Structure end # Describes a disk snapshot. # # @!attribute [rw] size_in_gb # The size of the disk in GB (e.g., `32`). # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DiskSnapshotInfo AWS API Documentation # class DiskSnapshotInfo < Struct.new( :size_in_gb) SENSITIVE = [] include Aws::Structure end # Describes the specifications of a distribution bundle. # # @!attribute [rw] bundle_id # The ID of the bundle. # @return [String] # # @!attribute [rw] name # The name of the distribution bundle. # @return [String] # # @!attribute [rw] price # The monthly price, in US dollars, of the bundle. # @return [Float] # # @!attribute [rw] transfer_per_month_in_gb # The monthly network transfer quota of the bundle. # @return [Integer] # # @!attribute [rw] is_active # Indicates whether the bundle is active, and can be specified for a # new or existing distribution. # @return [Boolean] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DistributionBundle AWS API Documentation # class DistributionBundle < Struct.new( :bundle_id, :name, :price, :transfer_per_month_in_gb, :is_active) SENSITIVE = [] include Aws::Structure end # Describes a domain where you are storing recordsets. # # @!attribute [rw] name # The name of the domain. # @return [String] # # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the domain recordset (e.g., # `arn:aws:lightsail:global:123456789101:Domain/824cede0-abc7-4f84-8dbc-12345EXAMPLE`). # @return [String] # # @!attribute [rw] support_code # The support code. Include this code in your email to support when # you have questions about an instance or another resource in # Lightsail. This code enables our support team to look up your # Lightsail information more easily. # @return [String] # # @!attribute [rw] created_at # The date when the domain recordset was created. # @return [Time] # # @!attribute [rw] location # The AWS Region and Availability Zones where the domain recordset was # created. # @return [Types::ResourceLocation] # # @!attribute [rw] resource_type # The resource type. # @return [String] # # @!attribute [rw] tags # The tag keys and optional values for the resource. For more # information about tags in Lightsail, see the [Amazon Lightsail # Developer Guide][1]. # # # # [1]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags # @return [Array] # # @!attribute [rw] domain_entries # An array of key-value pairs containing information about the domain # entries. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/Domain AWS API Documentation # class Domain < Struct.new( :name, :arn, :support_code, :created_at, :location, :resource_type, :tags, :domain_entries) SENSITIVE = [] include Aws::Structure end # Describes a domain recordset entry. # # @note When making an API call, you may pass DomainEntry # data as a hash: # # { # id: "NonEmptyString", # name: "DomainName", # target: "string", # is_alias: false, # type: "DomainEntryType", # options: { # "DomainEntryOptionsKeys" => "string", # }, # } # # @!attribute [rw] id # The ID of the domain recordset entry. # @return [String] # # @!attribute [rw] name # The name of the domain. # @return [String] # # @!attribute [rw] target # The target IP address (e.g., `192.0.2.0`), or AWS name server (e.g., # `ns-111.awsdns-22.com.`). # # For Lightsail load balancers, the value looks like # `ab1234c56789c6b86aba6fb203d443bc-123456789.us-east-2.elb.amazonaws.com`. # For Lightsail distributions, the value looks like # `exampled1182ne.cloudfront.net`. For Lightsail container services, # the value looks like # `container-service-1.example23scljs.us-west-2.cs.amazonlightsail.com`. # Be sure to also set `isAlias` to `true` when setting up an A record # for a Lightsail load balancer, distribution, or container service. # @return [String] # # @!attribute [rw] is_alias # When `true`, specifies whether the domain entry is an alias used by # the Lightsail load balancer. You can include an alias (A type) # record in your request, which points to a load balancer DNS name and # routes traffic to your load balancer. # @return [Boolean] # # @!attribute [rw] type # The type of domain entry, such as address for IPv4 (A), address for # IPv6 (AAAA), canonical name (CNAME), mail exchanger (MX), name # server (NS), start of authority (SOA), service locator (SRV), or # text (TXT). # # The following domain entry types can be used: # # * `A` # # * `AAAA` # # * `CNAME` # # * `MX` # # * `NS` # # * `SOA` # # * `SRV` # # * `TXT` # @return [String] # # @!attribute [rw] options # (Deprecated) The options for the domain entry. # # In releases prior to November 29, 2017, this parameter was not # included in the API response. It is now deprecated. # # # @return [Hash] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DomainEntry AWS API Documentation # class DomainEntry < Struct.new( :id, :name, :target, :is_alias, :type, :options) SENSITIVE = [] include Aws::Structure end # Describes the domain validation records of an Amazon Lightsail SSL/TLS # certificate. # # @!attribute [rw] domain_name # The domain name of the certificate validation record. For example, # `example.com` or `www.example.com`. # @return [String] # # @!attribute [rw] resource_record # An object that describes the DNS records to add to your domain's # DNS to validate it for the certificate. # @return [Types::ResourceRecord] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DomainValidationRecord AWS API Documentation # class DomainValidationRecord < Struct.new( :domain_name, :resource_record) SENSITIVE = [] include Aws::Structure end # @api private # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DownloadDefaultKeyPairRequest AWS API Documentation # class DownloadDefaultKeyPairRequest < Aws::EmptyStructure; end # @!attribute [rw] public_key_base_64 # A base64-encoded public key of the `ssh-rsa` type. # @return [String] # # @!attribute [rw] private_key_base_64 # A base64-encoded RSA private key. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DownloadDefaultKeyPairResult AWS API Documentation # class DownloadDefaultKeyPairResult < Struct.new( :public_key_base_64, :private_key_base_64) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass EnableAddOnRequest # data as a hash: # # { # resource_name: "ResourceName", # required # add_on_request: { # required # add_on_type: "AutoSnapshot", # required, accepts AutoSnapshot # auto_snapshot_add_on_request: { # snapshot_time_of_day: "TimeOfDay", # }, # }, # } # # @!attribute [rw] resource_name # The name of the source resource for which to enable or modify the # add-on. # @return [String] # # @!attribute [rw] add_on_request # An array of strings representing the add-on to enable or modify. # @return [Types::AddOnRequest] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/EnableAddOnRequest AWS API Documentation # class EnableAddOnRequest < Struct.new( :resource_name, :add_on_request) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] operations # An array of objects that describe the result of the action, such as # the status of the request, the timestamp of the request, and the # resources affected by the request. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/EnableAddOnResult AWS API Documentation # class EnableAddOnResult < Struct.new( :operations) SENSITIVE = [] include Aws::Structure end # Describes the settings of a public endpoint for an Amazon Lightsail # container service. # # @note When making an API call, you may pass EndpointRequest # data as a hash: # # { # container_name: "string", # required # container_port: 1, # required # health_check: { # healthy_threshold: 1, # unhealthy_threshold: 1, # timeout_seconds: 1, # interval_seconds: 1, # path: "string", # success_codes: "string", # }, # } # # @!attribute [rw] container_name # The name of the container for the endpoint. # @return [String] # # @!attribute [rw] container_port # The port of the container to which traffic is forwarded to. # @return [Integer] # # @!attribute [rw] health_check # An object that describes the health check configuration of the # container. # @return [Types::ContainerServiceHealthCheckConfig] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/EndpointRequest AWS API Documentation # class EndpointRequest < Struct.new( :container_name, :container_port, :health_check) SENSITIVE = [] include Aws::Structure end # Describes an export snapshot record. # # @!attribute [rw] name # The export snapshot record name. # @return [String] # # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the export snapshot record. # @return [String] # # @!attribute [rw] created_at # The date when the export snapshot record was created. # @return [Time] # # @!attribute [rw] location # The AWS Region and Availability Zone where the export snapshot # record is located. # @return [Types::ResourceLocation] # # @!attribute [rw] resource_type # The Lightsail resource type (e.g., `ExportSnapshotRecord`). # @return [String] # # @!attribute [rw] state # The state of the export snapshot record. # @return [String] # # @!attribute [rw] source_info # A list of objects describing the source of the export snapshot # record. # @return [Types::ExportSnapshotRecordSourceInfo] # # @!attribute [rw] destination_info # A list of objects describing the destination of the export snapshot # record. # @return [Types::DestinationInfo] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/ExportSnapshotRecord AWS API Documentation # class ExportSnapshotRecord < Struct.new( :name, :arn, :created_at, :location, :resource_type, :state, :source_info, :destination_info) SENSITIVE = [] include Aws::Structure end # Describes the source of an export snapshot record. # # @!attribute [rw] resource_type # The Lightsail resource type (e.g., `InstanceSnapshot` or # `DiskSnapshot`). # @return [String] # # @!attribute [rw] created_at # The date when the source instance or disk snapshot was created. # @return [Time] # # @!attribute [rw] name # The name of the source instance or disk snapshot. # @return [String] # # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the source instance or disk # snapshot. # @return [String] # # @!attribute [rw] from_resource_name # The name of the snapshot's source instance or disk. # @return [String] # # @!attribute [rw] from_resource_arn # The Amazon Resource Name (ARN) of the snapshot's source instance or # disk. # @return [String] # # @!attribute [rw] instance_snapshot_info # A list of objects describing an instance snapshot. # @return [Types::InstanceSnapshotInfo] # # @!attribute [rw] disk_snapshot_info # A list of objects describing a disk snapshot. # @return [Types::DiskSnapshotInfo] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/ExportSnapshotRecordSourceInfo AWS API Documentation # class ExportSnapshotRecordSourceInfo < Struct.new( :resource_type, :created_at, :name, :arn, :from_resource_name, :from_resource_arn, :instance_snapshot_info, :disk_snapshot_info) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass ExportSnapshotRequest # data as a hash: # # { # source_snapshot_name: "ResourceName", # required # } # # @!attribute [rw] source_snapshot_name # The name of the instance or disk snapshot to be exported to Amazon # EC2. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/ExportSnapshotRequest AWS API Documentation # class ExportSnapshotRequest < Struct.new( :source_snapshot_name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] operations # An array of objects that describe the result of the action, such as # the status of the request, the timestamp of the request, and the # resources affected by the request. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/ExportSnapshotResult AWS API Documentation # class ExportSnapshotResult < Struct.new( :operations) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass GetActiveNamesRequest # data as a hash: # # { # page_token: "string", # } # # @!attribute [rw] page_token # The token to advance to the next page of results from your request. # # To get a page token, perform an initial `GetActiveNames` 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. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetActiveNamesRequest AWS API Documentation # class GetActiveNamesRequest < Struct.new( :page_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] active_names # The list of active names returned by the get active names request. # @return [Array] # # @!attribute [rw] next_page_token # The token to advance to the next page of results from your request. # # A next page token is not returned if there are no more results to # display. # # To get the next page of results, perform another `GetActiveNames` # request and specify the next page token using the `pageToken` # parameter. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetActiveNamesResult AWS API Documentation # class GetActiveNamesResult < Struct.new( :active_names, :next_page_token) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass GetAlarmsRequest # data as a hash: # # { # alarm_name: "ResourceName", # page_token: "string", # monitored_resource_name: "ResourceName", # } # # @!attribute [rw] alarm_name # The name of the alarm. # # Specify an alarm name to return information about a specific alarm. # @return [String] # # @!attribute [rw] page_token # The token to advance to the next page of results from your request. # # To get a page token, perform an initial `GetAlarms` 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. # @return [String] # # @!attribute [rw] monitored_resource_name # The name of the Lightsail resource being monitored by the alarm. # # Specify a monitored resource name to return information about all # alarms for a specific resource. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetAlarmsRequest AWS API Documentation # class GetAlarmsRequest < Struct.new( :alarm_name, :page_token, :monitored_resource_name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] alarms # An array of objects that describe the alarms. # @return [Array] # # @!attribute [rw] next_page_token # The token to advance to the next page of results from your request. # # A next page token is not returned if there are no more results to # display. # # To get the next page of results, perform another `GetAlarms` request # and specify the next page token using the `pageToken` parameter. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetAlarmsResult AWS API Documentation # class GetAlarmsResult < Struct.new( :alarms, :next_page_token) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass GetAutoSnapshotsRequest # data as a hash: # # { # resource_name: "ResourceName", # required # } # # @!attribute [rw] resource_name # The name of the source instance or disk from which to get automatic # snapshot information. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetAutoSnapshotsRequest AWS API Documentation # class GetAutoSnapshotsRequest < Struct.new( :resource_name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] resource_name # The name of the source instance or disk for the automatic snapshots. # @return [String] # # @!attribute [rw] resource_type # The resource type (e.g., `Instance` or `Disk`). # @return [String] # # @!attribute [rw] auto_snapshots # An array of objects that describe the automatic snapshots that are # available for the specified source instance or disk. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetAutoSnapshotsResult AWS API Documentation # class GetAutoSnapshotsResult < Struct.new( :resource_name, :resource_type, :auto_snapshots) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass GetBlueprintsRequest # data as a hash: # # { # include_inactive: false, # page_token: "string", # } # # @!attribute [rw] include_inactive # A Boolean value indicating whether to include inactive results in # your request. # @return [Boolean] # # @!attribute [rw] page_token # The token to advance to the next page of results from your request. # # To get a page token, perform an initial `GetBlueprints` 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. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetBlueprintsRequest AWS API Documentation # class GetBlueprintsRequest < Struct.new( :include_inactive, :page_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] blueprints # An array of key-value pairs that contains information about the # available blueprints. # @return [Array] # # @!attribute [rw] next_page_token # The token to advance to the next page of results from your request. # # A next page token is not returned if there are no more results to # display. # # To get the next page of results, perform another `GetBlueprints` # request and specify the next page token using the `pageToken` # parameter. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetBlueprintsResult AWS API Documentation # class GetBlueprintsResult < Struct.new( :blueprints, :next_page_token) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass GetBucketAccessKeysRequest # data as a hash: # # { # bucket_name: "BucketName", # required # } # # @!attribute [rw] bucket_name # The name of the bucket for which to return access keys. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetBucketAccessKeysRequest AWS API Documentation # class GetBucketAccessKeysRequest < Struct.new( :bucket_name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] access_keys # An object that describes the access keys for the specified bucket. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetBucketAccessKeysResult AWS API Documentation # class GetBucketAccessKeysResult < Struct.new( :access_keys) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass GetBucketBundlesRequest # data as a hash: # # { # include_inactive: false, # } # # @!attribute [rw] include_inactive # A Boolean value that indicates whether to include inactive # (unavailable) bundles in the response. # @return [Boolean] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetBucketBundlesRequest AWS API Documentation # class GetBucketBundlesRequest < Struct.new( :include_inactive) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bundles # An object that describes bucket bundles. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetBucketBundlesResult AWS API Documentation # class GetBucketBundlesResult < Struct.new( :bundles) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass GetBucketMetricDataRequest # data as a hash: # # { # bucket_name: "BucketName", # required # metric_name: "BucketSizeBytes", # required, accepts BucketSizeBytes, NumberOfObjects # start_time: Time.now, # required # end_time: Time.now, # required # period: 1, # required # statistics: ["Minimum"], # required, accepts Minimum, Maximum, Sum, Average, SampleCount # unit: "Seconds", # required, accepts Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None # } # # @!attribute [rw] bucket_name # The name of the bucket for which to get metric data. # @return [String] # # @!attribute [rw] metric_name # The metric for which you want to return information. # # Valid bucket metric names are listed below, along with the most # useful statistics to include in your request, and the published unit # value. # # These bucket metrics are reported once per day. # # # # * BucketSizeBytes - The amount of data in # bytes stored in a bucket. This value is calculated by summing the # size of all objects in the bucket (including object versions), # including the size of all parts for all incomplete multipart # uploads to the bucket. # # Statistics: The most useful statistic is `Maximum`. # # Unit: The published unit is `Bytes`. # # * NumberOfObjects - The total number of # objects stored in a bucket. This value is calculated by counting # all objects in the bucket (including object versions) and the # total number of parts for all incomplete multipart uploads to the # bucket. # # Statistics: The most useful statistic is `Average`. # # Unit: The published unit is `Count`. # @return [String] # # @!attribute [rw] start_time # The timestamp indicating the earliest data to be returned. # @return [Time] # # @!attribute [rw] end_time # The timestamp indicating the latest data to be returned. # @return [Time] # # @!attribute [rw] period # The granularity, in seconds, of the returned data points. # # Bucket storage metrics are reported once per day. Therefore, you # should specify a period of 86400 seconds, which is the number of # seconds in a day. # # # @return [Integer] # # @!attribute [rw] statistics # The statistic for the metric. # # The following statistics are available: # # * `Minimum` - The lowest value observed during the specified period. # Use this value to determine low volumes of activity for your # application. # # * `Maximum` - The highest value observed during the specified # period. Use this value to determine high volumes of activity for # your application. # # * `Sum` - The sum of all values submitted for the matching metric. # You can use this statistic to determine the total volume of a # metric. # # * `Average` - The value of `Sum` / `SampleCount` during the # specified period. By comparing this statistic with the `Minimum` # and `Maximum` values, you can determine the full scope of a metric # and how close the average use is to the `Minimum` and `Maximum` # values. This comparison helps you to know when to increase or # decrease your resources. # # * `SampleCount` - The count, or number, of data points used for the # statistical calculation. # @return [Array] # # @!attribute [rw] unit # The unit for the metric data request. # # Valid units depend on the metric data being requested. For the valid # units with each available metric, see the `metricName` parameter. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetBucketMetricDataRequest AWS API Documentation # class GetBucketMetricDataRequest < Struct.new( :bucket_name, :metric_name, :start_time, :end_time, :period, :statistics, :unit) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] metric_name # The name of the metric returned. # @return [String] # # @!attribute [rw] metric_data # An array of objects that describe the metric data returned. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetBucketMetricDataResult AWS API Documentation # class GetBucketMetricDataResult < Struct.new( :metric_name, :metric_data) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass GetBucketsRequest # data as a hash: # # { # bucket_name: "BucketName", # page_token: "string", # include_connected_resources: false, # } # # @!attribute [rw] bucket_name # The name of the bucket for which to return information. # # When omitted, the response includes all of your buckets in the AWS # Region where the request is made. # @return [String] # # @!attribute [rw] page_token # The token to advance to the next page of results from your request. # # To get a page token, perform an initial `GetBuckets` 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. # @return [String] # # @!attribute [rw] include_connected_resources # A Boolean value that indicates whether to include Lightsail # instances that were given access to the bucket using the # SetResourceAccessForBucket action. # @return [Boolean] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetBucketsRequest AWS API Documentation # class GetBucketsRequest < Struct.new( :bucket_name, :page_token, :include_connected_resources) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] buckets # An array of objects that describe buckets. # @return [Array] # # @!attribute [rw] next_page_token # The token to advance to the next page of results from your request. # # A next page token is not returned if there are no more results to # display. # # To get the next page of results, perform another `GetBuckets` # request and specify the next page token using the `pageToken` # parameter. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetBucketsResult AWS API Documentation # class GetBucketsResult < Struct.new( :buckets, :next_page_token) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass GetBundlesRequest # data as a hash: # # { # include_inactive: false, # page_token: "string", # } # # @!attribute [rw] include_inactive # A Boolean value that indicates whether to include inactive bundle # results in your request. # @return [Boolean] # # @!attribute [rw] page_token # The token to advance to the next page of results from your request. # # To get a page token, perform an initial `GetBundles` 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. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetBundlesRequest AWS API Documentation # class GetBundlesRequest < Struct.new( :include_inactive, :page_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bundles # An array of key-value pairs that contains information about the # available bundles. # @return [Array] # # @!attribute [rw] next_page_token # The token to advance to the next page of results from your request. # # A next page token is not returned if there are no more results to # display. # # To get the next page of results, perform another `GetBundles` # request and specify the next page token using the `pageToken` # parameter. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetBundlesResult AWS API Documentation # class GetBundlesResult < Struct.new( :bundles, :next_page_token) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass GetCertificatesRequest # data as a hash: # # { # certificate_statuses: ["PENDING_VALIDATION"], # accepts PENDING_VALIDATION, ISSUED, INACTIVE, EXPIRED, VALIDATION_TIMED_OUT, REVOKED, FAILED # include_certificate_details: false, # certificate_name: "CertificateName", # } # # @!attribute [rw] certificate_statuses # The status of the certificates for which to return information. # # For example, specify `ISSUED` to return only certificates with an # `ISSUED` status. # # When omitted, the response includes all of your certificates in the # AWS Region where the request is made, regardless of their current # status. # @return [Array] # # @!attribute [rw] include_certificate_details # Indicates whether to include detailed information about the # certificates in the response. # # When omitted, the response includes only the certificate names, # Amazon Resource Names (ARNs), domain names, and tags. # @return [Boolean] # # @!attribute [rw] certificate_name # The name for the certificate for which to return information. # # When omitted, the response includes all of your certificates in the # AWS Region where the request is made. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetCertificatesRequest AWS API Documentation # class GetCertificatesRequest < Struct.new( :certificate_statuses, :include_certificate_details, :certificate_name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] certificates # An object that describes certificates. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetCertificatesResult AWS API Documentation # class GetCertificatesResult < Struct.new( :certificates) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass GetCloudFormationStackRecordsRequest # data as a hash: # # { # page_token: "string", # } # # @!attribute [rw] page_token # The token to advance to the next page of results from your request. # # To get a page token, perform an initial # `GetClouFormationStackRecords` 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. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetCloudFormationStackRecordsRequest AWS API Documentation # class GetCloudFormationStackRecordsRequest < Struct.new( :page_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] cloud_formation_stack_records # A list of objects describing the CloudFormation stack records. # @return [Array] # # @!attribute [rw] next_page_token # The token to advance to the next page of results from your request. # # A next page token is not returned if there are no more results to # display. # # To get the next page of results, perform another # `GetCloudFormationStackRecords` request and specify the next page # token using the `pageToken` parameter. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetCloudFormationStackRecordsResult AWS API Documentation # class GetCloudFormationStackRecordsResult < Struct.new( :cloud_formation_stack_records, :next_page_token) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass GetContactMethodsRequest # data as a hash: # # { # protocols: ["Email"], # accepts Email, SMS # } # # @!attribute [rw] protocols # The protocols used to send notifications, such as `Email`, or `SMS` # (text messaging). # # Specify a protocol in your request to return information about a # specific contact method protocol. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetContactMethodsRequest AWS API Documentation # class GetContactMethodsRequest < Struct.new( :protocols) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] contact_methods # An array of objects that describe the contact methods. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetContactMethodsResult AWS API Documentation # class GetContactMethodsResult < Struct.new( :contact_methods) SENSITIVE = [] include Aws::Structure end # @api private # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetContainerAPIMetadataRequest AWS API Documentation # class GetContainerAPIMetadataRequest < Aws::EmptyStructure; end # @!attribute [rw] metadata # Metadata about Lightsail containers, such as the current version of # the Lightsail Control (lightsailctl) plugin. # @return [Array>] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetContainerAPIMetadataResult AWS API Documentation # class GetContainerAPIMetadataResult < Struct.new( :metadata) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass GetContainerImagesRequest # data as a hash: # # { # service_name: "ContainerServiceName", # required # } # # @!attribute [rw] service_name # The name of the container service for which to return registered # container images. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetContainerImagesRequest AWS API Documentation # class GetContainerImagesRequest < Struct.new( :service_name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] container_images # An array of objects that describe container images that are # registered to the container service. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetContainerImagesResult AWS API Documentation # class GetContainerImagesResult < Struct.new( :container_images) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass GetContainerLogRequest # data as a hash: # # { # service_name: "ContainerServiceName", # required # container_name: "string", # required # start_time: Time.now, # end_time: Time.now, # filter_pattern: "string", # page_token: "string", # } # # @!attribute [rw] service_name # The name of the container service for which to get a container log. # @return [String] # # @!attribute [rw] container_name # The name of the container that is either running or previously ran # on the container service for which to return a log. # @return [String] # # @!attribute [rw] start_time # The start of the time interval for which to get log data. # # Constraints: # # * Specified in Coordinated Universal Time (UTC). # # * Specified in the Unix time format. # # For example, if you wish to use a start time of October 1, 2018, # at 8 PM UTC, specify `1538424000` as the start time. # # You can convert a human-friendly time to Unix time format using a # converter like [Epoch converter][1]. # # # # [1]: https://www.epochconverter.com/ # @return [Time] # # @!attribute [rw] end_time # The end of the time interval for which to get log data. # # Constraints: # # * Specified in Coordinated Universal Time (UTC). # # * Specified in the Unix time format. # # For example, if you wish to use an end time of October 1, 2018, at # 9 PM UTC, specify `1538427600` as the end time. # # You can convert a human-friendly time to Unix time format using a # converter like [Epoch converter][1]. # # # # [1]: https://www.epochconverter.com/ # @return [Time] # # @!attribute [rw] filter_pattern # The pattern to use to filter the returned log events to a specific # term. # # The following are a few examples of filter patterns that you can # specify: # # * To return all log events, specify a filter pattern of `""`. # # * To exclude log events that contain the `ERROR` term, and return # all other log events, specify a filter pattern of `"-ERROR"`. # # * To return log events that contain the `ERROR` term, specify a # filter pattern of `"ERROR"`. # # * To return log events that contain both the `ERROR` and `Exception` # terms, specify a filter pattern of `"ERROR Exception"`. # # * To return log events that contain the `ERROR` *or* the `Exception` # term, specify a filter pattern of `"?ERROR ?Exception"`. # @return [String] # # @!attribute [rw] page_token # The token to advance to the next page of results from your request. # # To get a page token, perform an initial `GetContainerLog` 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. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetContainerLogRequest AWS API Documentation # class GetContainerLogRequest < Struct.new( :service_name, :container_name, :start_time, :end_time, :filter_pattern, :page_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] log_events # An array of objects that describe the log events of a container. # @return [Array] # # @!attribute [rw] next_page_token # The token to advance to the next page of results from your request. # # A next page token is not returned if there are no more results to # display. # # To get the next page of results, perform another `GetContainerLog` # request and specify the next page token using the `pageToken` # parameter. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetContainerLogResult AWS API Documentation # class GetContainerLogResult < Struct.new( :log_events, :next_page_token) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass GetContainerServiceDeploymentsRequest # data as a hash: # # { # service_name: "ContainerServiceName", # required # } # # @!attribute [rw] service_name # The name of the container service for which to return deployments. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetContainerServiceDeploymentsRequest AWS API Documentation # class GetContainerServiceDeploymentsRequest < Struct.new( :service_name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] deployments # An array of objects that describe deployments for a container # service. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetContainerServiceDeploymentsResult AWS API Documentation # class GetContainerServiceDeploymentsResult < Struct.new( :deployments) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass GetContainerServiceMetricDataRequest # data as a hash: # # { # service_name: "ContainerServiceName", # required # metric_name: "CPUUtilization", # required, accepts CPUUtilization, MemoryUtilization # start_time: Time.now, # required # end_time: Time.now, # required # period: 1, # required # statistics: ["Minimum"], # required, accepts Minimum, Maximum, Sum, Average, SampleCount # } # # @!attribute [rw] service_name # The name of the container service for which to get metric data. # @return [String] # # @!attribute [rw] metric_name # The metric for which you want to return information. # # Valid container service metric names are listed below, along with # the most useful statistics to include in your request, and the # published unit value. # # * `CPUUtilization` - The average percentage of compute units that # are currently in use across all nodes of the container service. # This metric identifies the processing power required to run # containers on each node of the container service. # # Statistics: The most useful statistics are `Maximum` and # `Average`. # # Unit: The published unit is `Percent`. # # * `MemoryUtilization` - The average percentage of available memory # that is currently in use across all nodes of the container # service. This metric identifies the memory required to run # containers on each node of the container service. # # Statistics: The most useful statistics are `Maximum` and # `Average`. # # Unit: The published unit is `Percent`. # @return [String] # # @!attribute [rw] start_time # The start time of the time period. # @return [Time] # # @!attribute [rw] end_time # The end time of the time period. # @return [Time] # # @!attribute [rw] period # The granularity, in seconds, of the returned data points. # # All container service metric data is available in 5-minute (300 # seconds) granularity. # @return [Integer] # # @!attribute [rw] statistics # The statistic for the metric. # # The following statistics are available: # # * `Minimum` - The lowest value observed during the specified period. # Use this value to determine low volumes of activity for your # application. # # * `Maximum` - The highest value observed during the specified # period. Use this value to determine high volumes of activity for # your application. # # * `Sum` - All values submitted for the matching metric added # together. You can use this statistic to determine the total volume # of a metric. # # * `Average` - The value of `Sum` / `SampleCount` during the # specified period. By comparing this statistic with the `Minimum` # and `Maximum` values, you can determine the full scope of a metric # and how close the average use is to the `Minimum` and `Maximum` # values. This comparison helps you to know when to increase or # decrease your resources. # # * `SampleCount` - The count, or number, of data points used for the # statistical calculation. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetContainerServiceMetricDataRequest AWS API Documentation # class GetContainerServiceMetricDataRequest < Struct.new( :service_name, :metric_name, :start_time, :end_time, :period, :statistics) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] metric_name # The name of the metric returned. # @return [String] # # @!attribute [rw] metric_data # An array of objects that describe the metric data returned. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetContainerServiceMetricDataResult AWS API Documentation # class GetContainerServiceMetricDataResult < Struct.new( :metric_name, :metric_data) SENSITIVE = [] include Aws::Structure end # @api private # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetContainerServicePowersRequest AWS API Documentation # class GetContainerServicePowersRequest < Aws::EmptyStructure; end # @!attribute [rw] powers # An array of objects that describe the powers that can be specified # for a container service. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetContainerServicePowersResult AWS API Documentation # class GetContainerServicePowersResult < Struct.new( :powers) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass GetContainerServicesRequest # data as a hash: # # { # service_name: "ContainerServiceName", # } # # @!attribute [rw] service_name # The name of the container service for which to return information. # # When omitted, the response includes all of your container services # in the AWS Region where the request is made. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetContainerServicesRequest AWS API Documentation # class GetContainerServicesRequest < Struct.new( :service_name) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass GetDiskRequest # data as a hash: # # { # disk_name: "ResourceName", # required # } # # @!attribute [rw] disk_name # The name of the disk (e.g., `my-disk`). # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetDiskRequest AWS API Documentation # class GetDiskRequest < Struct.new( :disk_name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] disk # An object containing information about the disk. # @return [Types::Disk] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetDiskResult AWS API Documentation # class GetDiskResult < Struct.new( :disk) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass GetDiskSnapshotRequest # data as a hash: # # { # disk_snapshot_name: "ResourceName", # required # } # # @!attribute [rw] disk_snapshot_name # The name of the disk snapshot (e.g., `my-disk-snapshot`). # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetDiskSnapshotRequest AWS API Documentation # class GetDiskSnapshotRequest < Struct.new( :disk_snapshot_name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] disk_snapshot # An object containing information about the disk snapshot. # @return [Types::DiskSnapshot] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetDiskSnapshotResult AWS API Documentation # class GetDiskSnapshotResult < Struct.new( :disk_snapshot) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass GetDiskSnapshotsRequest # data as a hash: # # { # page_token: "string", # } # # @!attribute [rw] page_token # The token to advance to the next page of results from your request. # # To get a page token, perform an initial `GetDiskSnapshots` 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. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetDiskSnapshotsRequest AWS API Documentation # class GetDiskSnapshotsRequest < Struct.new( :page_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] disk_snapshots # An array of objects containing information about all block storage # disk snapshots. # @return [Array] # # @!attribute [rw] next_page_token # The token to advance to the next page of results from your request. # # A next page token is not returned if there are no more results to # display. # # To get the next page of results, perform another `GetDiskSnapshots` # request and specify the next page token using the `pageToken` # parameter. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetDiskSnapshotsResult AWS API Documentation # class GetDiskSnapshotsResult < Struct.new( :disk_snapshots, :next_page_token) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass GetDisksRequest # data as a hash: # # { # page_token: "string", # } # # @!attribute [rw] page_token # The token to advance to the next page of results from your request. # # To get a page token, perform an initial `GetDisks` 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. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetDisksRequest AWS API Documentation # class GetDisksRequest < Struct.new( :page_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] disks # An array of objects containing information about all block storage # disks. # @return [Array] # # @!attribute [rw] next_page_token # The token to advance to the next page of results from your request. # # A next page token is not returned if there are no more results to # display. # # To get the next page of results, perform another `GetDisks` request # and specify the next page token using the `pageToken` parameter. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetDisksResult AWS API Documentation # class GetDisksResult < Struct.new( :disks, :next_page_token) SENSITIVE = [] include Aws::Structure end # @api private # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetDistributionBundlesRequest AWS API Documentation # class GetDistributionBundlesRequest < Aws::EmptyStructure; end # @!attribute [rw] bundles # An object that describes a distribution bundle. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetDistributionBundlesResult AWS API Documentation # class GetDistributionBundlesResult < Struct.new( :bundles) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass GetDistributionLatestCacheResetRequest # data as a hash: # # { # distribution_name: "ResourceName", # } # # @!attribute [rw] distribution_name # The name of the distribution for which to return the timestamp of # the last cache reset. # # Use the `GetDistributions` action to get a list of distribution # names that you can specify. # # When omitted, the response includes the latest cache reset timestamp # of all your distributions. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetDistributionLatestCacheResetRequest AWS API Documentation # class GetDistributionLatestCacheResetRequest < Struct.new( :distribution_name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] status # The status of the last cache reset. # @return [String] # # @!attribute [rw] create_time # The timestamp of the last cache reset (e.g., `1479734909.17`) in # Unix time format. # @return [Time] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetDistributionLatestCacheResetResult AWS API Documentation # class GetDistributionLatestCacheResetResult < Struct.new( :status, :create_time) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass GetDistributionMetricDataRequest # data as a hash: # # { # distribution_name: "ResourceName", # required # metric_name: "Requests", # required, accepts Requests, BytesDownloaded, BytesUploaded, TotalErrorRate, Http4xxErrorRate, Http5xxErrorRate # start_time: Time.now, # required # end_time: Time.now, # required # period: 1, # required # unit: "Seconds", # required, accepts Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None # statistics: ["Minimum"], # required, accepts Minimum, Maximum, Sum, Average, SampleCount # } # # @!attribute [rw] distribution_name # The name of the distribution for which to get metric data. # # Use the `GetDistributions` action to get a list of distribution # names that you can specify. # @return [String] # # @!attribute [rw] metric_name # The metric for which you want to return information. # # Valid distribution metric names are listed below, along with the # most useful `statistics` to include in your request, and the # published `unit` value. # # * Requests - The total number of viewer # requests received by your Lightsail distribution, for all HTTP # methods, and for both HTTP and HTTPS requests. # # `Statistics`\: The most useful statistic is `Sum`. # # `Unit`\: The published unit is `None`. # # * BytesDownloaded - The number of bytes # downloaded by viewers for GET, HEAD, and OPTIONS requests. # # `Statistics`\: The most useful statistic is `Sum`. # # `Unit`\: The published unit is `None`. # # * BytesUploaded - The number of bytes # uploaded to your origin by your Lightsail distribution, using POST # and PUT requests. # # `Statistics`\: The most useful statistic is `Sum`. # # `Unit`\: The published unit is `None`. # # * TotalErrorRate - The percentage of all # viewer requests for which the response's HTTP status code was 4xx # or 5xx. # # `Statistics`\: The most useful statistic is `Average`. # # `Unit`\: The published unit is `Percent`. # # * 4xxErrorRate - The percentage of all viewer # requests for which the response's HTTP status cod was 4xx. In # these cases, the client or client viewer may have made an error. # For example, a status code of 404 (Not Found) means that the # client requested an object that could not be found. # # `Statistics`\: The most useful statistic is `Average`. # # `Unit`\: The published unit is `Percent`. # # * 5xxErrorRate - The percentage of all viewer # requests for which the response's HTTP status code was 5xx. In # these cases, the origin server did not satisfy the requests. For # example, a status code of 503 (Service Unavailable) means that the # origin server is currently unavailable. # # `Statistics`\: The most useful statistic is `Average`. # # `Unit`\: The published unit is `Percent`. # @return [String] # # @!attribute [rw] start_time # The start of the time interval for which to get metric data. # # Constraints: # # * Specified in Coordinated Universal Time (UTC). # # * Specified in the Unix time format. # # For example, if you wish to use a start time of October 1, 2018, # at 8 PM UTC, specify `1538424000` as the start time. # # You can convert a human-friendly time to Unix time format using a # converter like [Epoch converter][1]. # # # # [1]: https://www.epochconverter.com/ # @return [Time] # # @!attribute [rw] end_time # The end of the time interval for which to get metric data. # # Constraints: # # * Specified in Coordinated Universal Time (UTC). # # * Specified in the Unix time format. # # For example, if you wish to use an end time of October 1, 2018, at # 9 PM UTC, specify `1538427600` as the end time. # # You can convert a human-friendly time to Unix time format using a # converter like [Epoch converter][1]. # # # # [1]: https://www.epochconverter.com/ # @return [Time] # # @!attribute [rw] period # The granularity, in seconds, for the metric data points that will be # returned. # @return [Integer] # # @!attribute [rw] unit # The unit for the metric data request. # # Valid units depend on the metric data being requested. For the valid # units with each available metric, see the `metricName` parameter. # @return [String] # # @!attribute [rw] statistics # The statistic for the metric. # # The following statistics are available: # # * `Minimum` - The lowest value observed during the specified period. # Use this value to determine low volumes of activity for your # application. # # * `Maximum` - The highest value observed during the specified # period. Use this value to determine high volumes of activity for # your application. # # * `Sum` - All values submitted for the matching metric added # together. You can use this statistic to determine the total volume # of a metric. # # * `Average` - The value of Sum / SampleCount during the specified # period. By comparing this statistic with the Minimum and Maximum # values, you can determine the full scope of a metric and how close # the average use is to the Minimum and Maximum values. This # comparison helps you to know when to increase or decrease your # resources. # # * `SampleCount` - The count, or number, of data points used for the # statistical calculation. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetDistributionMetricDataRequest AWS API Documentation # class GetDistributionMetricDataRequest < Struct.new( :distribution_name, :metric_name, :start_time, :end_time, :period, :unit, :statistics) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] metric_name # The name of the metric returned. # @return [String] # # @!attribute [rw] metric_data # An array of objects that describe the metric data returned. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetDistributionMetricDataResult AWS API Documentation # class GetDistributionMetricDataResult < Struct.new( :metric_name, :metric_data) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass GetDistributionsRequest # data as a hash: # # { # distribution_name: "ResourceName", # page_token: "string", # } # # @!attribute [rw] distribution_name # The name of the distribution for which to return information. # # When omitted, the response includes all of your distributions in the # AWS Region where the request is made. # @return [String] # # @!attribute [rw] page_token # 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. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetDistributionsRequest AWS API Documentation # class GetDistributionsRequest < Struct.new( :distribution_name, :page_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] distributions # An array of objects that describe your distributions. # @return [Array] # # @!attribute [rw] next_page_token # The token to advance to the next page of results from your request. # # A next page token is not returned if there are no more results to # display. # # To get the next page of results, perform another `GetDistributions` # request and specify the next page token using the `pageToken` # parameter. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetDistributionsResult AWS API Documentation # class GetDistributionsResult < Struct.new( :distributions, :next_page_token) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass GetDomainRequest # data as a hash: # # { # domain_name: "DomainName", # required # } # # @!attribute [rw] domain_name # The domain name for which your want to return information about. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetDomainRequest AWS API Documentation # class GetDomainRequest < Struct.new( :domain_name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] domain # An array of key-value pairs containing information about your get # domain request. # @return [Types::Domain] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetDomainResult AWS API Documentation # class GetDomainResult < Struct.new( :domain) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass GetDomainsRequest # data as a hash: # # { # page_token: "string", # } # # @!attribute [rw] page_token # The token to advance to the next page of results from your request. # # To get a page token, perform an initial `GetDomains` 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. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetDomainsRequest AWS API Documentation # class GetDomainsRequest < Struct.new( :page_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] domains # An array of key-value pairs containing information about each of the # domain entries in the user's account. # @return [Array] # # @!attribute [rw] next_page_token # The token to advance to the next page of results from your request. # # A next page token is not returned if there are no more results to # display. # # To get the next page of results, perform another `GetDomains` # request and specify the next page token using the `pageToken` # parameter. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetDomainsResult AWS API Documentation # class GetDomainsResult < Struct.new( :domains, :next_page_token) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass GetExportSnapshotRecordsRequest # data as a hash: # # { # page_token: "string", # } # # @!attribute [rw] page_token # The token to advance to the next page of results from your request. # # To get a page token, perform an initial `GetExportSnapshotRecords` # 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. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetExportSnapshotRecordsRequest AWS API Documentation # class GetExportSnapshotRecordsRequest < Struct.new( :page_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] export_snapshot_records # A list of objects describing the export snapshot records. # @return [Array] # # @!attribute [rw] next_page_token # The token to advance to the next page of results from your request. # # A next page token is not returned if there are no more results to # display. # # To get the next page of results, perform another # `GetExportSnapshotRecords` request and specify the next page token # using the `pageToken` parameter. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetExportSnapshotRecordsResult AWS API Documentation # class GetExportSnapshotRecordsResult < Struct.new( :export_snapshot_records, :next_page_token) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass GetInstanceAccessDetailsRequest # data as a hash: # # { # instance_name: "ResourceName", # required # protocol: "ssh", # accepts ssh, rdp # } # # @!attribute [rw] instance_name # The name of the instance to access. # @return [String] # # @!attribute [rw] protocol # The protocol to use to connect to your instance. Defaults to `ssh`. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetInstanceAccessDetailsRequest AWS API Documentation # class GetInstanceAccessDetailsRequest < Struct.new( :instance_name, :protocol) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] access_details # An array of key-value pairs containing information about a get # instance access request. # @return [Types::InstanceAccessDetails] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetInstanceAccessDetailsResult AWS API Documentation # class GetInstanceAccessDetailsResult < Struct.new( :access_details) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass GetInstanceMetricDataRequest # data as a hash: # # { # instance_name: "ResourceName", # required # metric_name: "CPUUtilization", # required, accepts CPUUtilization, NetworkIn, NetworkOut, StatusCheckFailed, StatusCheckFailed_Instance, StatusCheckFailed_System, BurstCapacityTime, BurstCapacityPercentage # period: 1, # required # start_time: Time.now, # required # end_time: Time.now, # required # unit: "Seconds", # required, accepts Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None # statistics: ["Minimum"], # required, accepts Minimum, Maximum, Sum, Average, SampleCount # } # # @!attribute [rw] instance_name # The name of the instance for which you want to get metrics data. # @return [String] # # @!attribute [rw] metric_name # The metric for which you want to return information. # # Valid instance metric names are listed below, along with the most # useful `statistics` to include in your request, and the published # `unit` value. # # * BurstCapacityPercentage - The percentage of # CPU performance available for your instance to burst above its # baseline. Your instance continuously accrues and consumes burst # capacity. Burst capacity stops accruing when your instance's # `BurstCapacityPercentage` reaches 100%. For more information, see # [Viewing instance burst capacity in Amazon Lightsail][1]. # # `Statistics`\: The most useful statistics are `Maximum` and # `Average`. # # `Unit`\: The published unit is `Percent`. # # * BurstCapacityTime - The available amount of # time for your instance to burst at 100% CPU utilization. Your # instance continuously accrues and consumes burst capacity. Burst # capacity time stops accruing when your instance's # `BurstCapacityPercentage` metric reaches 100%. # # Burst capacity time is consumed at the full rate only when your # instance operates at 100% CPU utilization. For example, if your # instance operates at 50% CPU utilization in the burstable zone for # a 5-minute period, then it consumes CPU burst capacity minutes at # a 50% rate in that period. Your instance consumed 2 minutes and 30 # seconds of CPU burst capacity minutes in the 5-minute period. For # more information, see [Viewing instance burst capacity in Amazon # Lightsail][1]. # # `Statistics`\: The most useful statistics are `Maximum` and # `Average`. # # `Unit`\: The published unit is `Seconds`. # # * CPUUtilization - The percentage of allocated # compute units that are currently in use on the instance. This # metric identifies the processing power to run the applications on # the instance. Tools in your operating system can show a lower # percentage than Lightsail when the instance is not allocated a # full processor core. # # `Statistics`\: The most useful statistics are `Maximum` and # `Average`. # # `Unit`\: The published unit is `Percent`. # # * NetworkIn - The number of bytes received on # all network interfaces by the instance. This metric identifies the # volume of incoming network traffic to the instance. The number # reported is the number of bytes received during the period. # Because this metric is reported in 5-minute intervals, divide the # reported number by 300 to find Bytes/second. # # `Statistics`\: The most useful statistic is `Sum`. # # `Unit`\: The published unit is `Bytes`. # # * NetworkOut - The number of bytes sent out on # all network interfaces by the instance. This metric identifies the # volume of outgoing network traffic from the instance. The number # reported is the number of bytes sent during the period. Because # this metric is reported in 5-minute intervals, divide the reported # number by 300 to find Bytes/second. # # `Statistics`\: The most useful statistic is `Sum`. # # `Unit`\: The published unit is `Bytes`. # # * StatusCheckFailed - Reports whether the # instance passed or failed both the instance status check and the # system status check. This metric can be either 0 (passed) or 1 # (failed). This metric data is available in 1-minute (60 seconds) # granularity. # # `Statistics`\: The most useful statistic is `Sum`. # # `Unit`\: The published unit is `Count`. # # * StatusCheckFailed_Instance - Reports whether # the instance passed or failed the instance status check. This # metric can be either 0 (passed) or 1 (failed). This metric data is # available in 1-minute (60 seconds) granularity. # # `Statistics`\: The most useful statistic is `Sum`. # # `Unit`\: The published unit is `Count`. # # * StatusCheckFailed_System - Reports whether # the instance passed or failed the system status check. This metric # can be either 0 (passed) or 1 (failed). This metric data is # available in 1-minute (60 seconds) granularity. # # `Statistics`\: The most useful statistic is `Sum`. # # `Unit`\: The published unit is `Count`. # # # # [1]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-viewing-instance-burst-capacity # @return [String] # # @!attribute [rw] period # The granularity, in seconds, of the returned data points. # # The `StatusCheckFailed`, `StatusCheckFailed_Instance`, and # `StatusCheckFailed_System` instance metric data is available in # 1-minute (60 seconds) granularity. All other instance metric data is # available in 5-minute (300 seconds) granularity. # @return [Integer] # # @!attribute [rw] start_time # The start time of the time period. # @return [Time] # # @!attribute [rw] end_time # The end time of the time period. # @return [Time] # # @!attribute [rw] unit # The unit for the metric data request. Valid units depend on the # metric data being requested. For the valid units to specify with # each available metric, see the `metricName` parameter. # @return [String] # # @!attribute [rw] statistics # The statistic for the metric. # # The following statistics are available: # # * `Minimum` - The lowest value observed during the specified period. # Use this value to determine low volumes of activity for your # application. # # * `Maximum` - The highest value observed during the specified # period. Use this value to determine high volumes of activity for # your application. # # * `Sum` - All values submitted for the matching metric added # together. You can use this statistic to determine the total volume # of a metric. # # * `Average` - The value of Sum / SampleCount during the specified # period. By comparing this statistic with the Minimum and Maximum # values, you can determine the full scope of a metric and how close # the average use is to the Minimum and Maximum values. This # comparison helps you to know when to increase or decrease your # resources. # # * `SampleCount` - The count, or number, of data points used for the # statistical calculation. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetInstanceMetricDataRequest AWS API Documentation # class GetInstanceMetricDataRequest < Struct.new( :instance_name, :metric_name, :period, :start_time, :end_time, :unit, :statistics) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] metric_name # The name of the metric returned. # @return [String] # # @!attribute [rw] metric_data # An array of objects that describe the metric data returned. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetInstanceMetricDataResult AWS API Documentation # class GetInstanceMetricDataResult < Struct.new( :metric_name, :metric_data) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass GetInstancePortStatesRequest # data as a hash: # # { # instance_name: "ResourceName", # required # } # # @!attribute [rw] instance_name # The name of the instance for which to return firewall port states. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetInstancePortStatesRequest AWS API Documentation # class GetInstancePortStatesRequest < Struct.new( :instance_name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] port_states # An array of objects that describe the firewall port states for the # specified instance. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetInstancePortStatesResult AWS API Documentation # class GetInstancePortStatesResult < Struct.new( :port_states) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass GetInstanceRequest # data as a hash: # # { # instance_name: "ResourceName", # required # } # # @!attribute [rw] instance_name # The name of the instance. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetInstanceRequest AWS API Documentation # class GetInstanceRequest < Struct.new( :instance_name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] instance # An array of key-value pairs containing information about the # specified instance. # @return [Types::Instance] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetInstanceResult AWS API Documentation # class GetInstanceResult < Struct.new( :instance) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass GetInstanceSnapshotRequest # data as a hash: # # { # instance_snapshot_name: "ResourceName", # required # } # # @!attribute [rw] instance_snapshot_name # The name of the snapshot for which you are requesting information. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetInstanceSnapshotRequest AWS API Documentation # class GetInstanceSnapshotRequest < Struct.new( :instance_snapshot_name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] instance_snapshot # An array of key-value pairs containing information about the results # of your get instance snapshot request. # @return [Types::InstanceSnapshot] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetInstanceSnapshotResult AWS API Documentation # class GetInstanceSnapshotResult < Struct.new( :instance_snapshot) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass GetInstanceSnapshotsRequest # data as a hash: # # { # page_token: "string", # } # # @!attribute [rw] page_token # The token to advance to the next page of results from your request. # # To get a page token, perform an initial `GetInstanceSnapshots` # 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. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetInstanceSnapshotsRequest AWS API Documentation # class GetInstanceSnapshotsRequest < Struct.new( :page_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] instance_snapshots # An array of key-value pairs containing information about the results # of your get instance snapshots request. # @return [Array] # # @!attribute [rw] next_page_token # The token to advance to the next page of results from your request. # # A next page token is not returned if there are no more results to # display. # # To get the next page of results, perform another # `GetInstanceSnapshots` request and specify the next page token using # the `pageToken` parameter. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetInstanceSnapshotsResult AWS API Documentation # class GetInstanceSnapshotsResult < Struct.new( :instance_snapshots, :next_page_token) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass GetInstanceStateRequest # data as a hash: # # { # instance_name: "ResourceName", # required # } # # @!attribute [rw] instance_name # The name of the instance to get state information about. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetInstanceStateRequest AWS API Documentation # class GetInstanceStateRequest < Struct.new( :instance_name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] state # The state of the instance. # @return [Types::InstanceState] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetInstanceStateResult AWS API Documentation # class GetInstanceStateResult < Struct.new( :state) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass GetInstancesRequest # data as a hash: # # { # page_token: "string", # } # # @!attribute [rw] page_token # The token to advance to the next page of results from your request. # # To get a page token, perform an initial `GetInstances` 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. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetInstancesRequest AWS API Documentation # class GetInstancesRequest < Struct.new( :page_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] instances # An array of key-value pairs containing information about your # instances. # @return [Array] # # @!attribute [rw] next_page_token # The token to advance to the next page of results from your request. # # A next page token is not returned if there are no more results to # display. # # To get the next page of results, perform another `GetInstances` # request and specify the next page token using the `pageToken` # parameter. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetInstancesResult AWS API Documentation # class GetInstancesResult < Struct.new( :instances, :next_page_token) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass GetKeyPairRequest # data as a hash: # # { # key_pair_name: "ResourceName", # required # } # # @!attribute [rw] key_pair_name # The name of the key pair for which you are requesting information. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetKeyPairRequest AWS API Documentation # class GetKeyPairRequest < Struct.new( :key_pair_name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] key_pair # An array of key-value pairs containing information about the key # pair. # @return [Types::KeyPair] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetKeyPairResult AWS API Documentation # class GetKeyPairResult < Struct.new( :key_pair) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass GetKeyPairsRequest # data as a hash: # # { # page_token: "string", # } # # @!attribute [rw] page_token # The token to advance to the next page of results from your request. # # To get a page token, perform an initial `GetKeyPairs` 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. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetKeyPairsRequest AWS API Documentation # class GetKeyPairsRequest < Struct.new( :page_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] key_pairs # An array of key-value pairs containing information about the key # pairs. # @return [Array] # # @!attribute [rw] next_page_token # The token to advance to the next page of results from your request. # # A next page token is not returned if there are no more results to # display. # # To get the next page of results, perform another `GetKeyPairs` # request and specify the next page token using the `pageToken` # parameter. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetKeyPairsResult AWS API Documentation # class GetKeyPairsResult < Struct.new( :key_pairs, :next_page_token) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass GetLoadBalancerMetricDataRequest # data as a hash: # # { # load_balancer_name: "ResourceName", # required # metric_name: "ClientTLSNegotiationErrorCount", # required, accepts ClientTLSNegotiationErrorCount, HealthyHostCount, UnhealthyHostCount, HTTPCode_LB_4XX_Count, HTTPCode_LB_5XX_Count, HTTPCode_Instance_2XX_Count, HTTPCode_Instance_3XX_Count, HTTPCode_Instance_4XX_Count, HTTPCode_Instance_5XX_Count, InstanceResponseTime, RejectedConnectionCount, RequestCount # period: 1, # required # start_time: Time.now, # required # end_time: Time.now, # required # unit: "Seconds", # required, accepts Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None # statistics: ["Minimum"], # required, accepts Minimum, Maximum, Sum, Average, SampleCount # } # # @!attribute [rw] load_balancer_name # The name of the load balancer. # @return [String] # # @!attribute [rw] metric_name # The metric for which you want to return information. # # Valid load balancer metric names are listed below, along with the # most useful `statistics` to include in your request, and the # published `unit` value. # # * ClientTLSNegotiationErrorCount - The number # of TLS connections initiated by the client that did not establish # a session with the load balancer due to a TLS error generated by # the load balancer. Possible causes include a mismatch of ciphers # or protocols. # # `Statistics`\: The most useful statistic is `Sum`. # # `Unit`\: The published unit is `Count`. # # * HealthyHostCount - The number of target # instances that are considered healthy. # # `Statistics`\: The most useful statistic are `Average`, `Minimum`, # and `Maximum`. # # `Unit`\: The published unit is `Count`. # # * HTTPCode_Instance_2XX_Count - The number of # HTTP 2XX response codes generated by the target instances. This # does not include any response codes generated by the load # balancer. # # `Statistics`\: The most useful statistic is `Sum`. Note that # `Minimum`, `Maximum`, and `Average` all return `1`. # # `Unit`\: The published unit is `Count`. # # * HTTPCode_Instance_3XX_Count - The number of # HTTP 3XX response codes generated by the target instances. This # does not include any response codes generated by the load # balancer. # # `Statistics`\: The most useful statistic is `Sum`. Note that # `Minimum`, `Maximum`, and `Average` all return `1`. # # `Unit`\: The published unit is `Count`. # # * HTTPCode_Instance_4XX_Count - The number of # HTTP 4XX response codes generated by the target instances. This # does not include any response codes generated by the load # balancer. # # `Statistics`\: The most useful statistic is `Sum`. Note that # `Minimum`, `Maximum`, and `Average` all return `1`. # # `Unit`\: The published unit is `Count`. # # * HTTPCode_Instance_5XX_Count - The number of # HTTP 5XX response codes generated by the target instances. This # does not include any response codes generated by the load # balancer. # # `Statistics`\: The most useful statistic is `Sum`. Note that # `Minimum`, `Maximum`, and `Average` all return `1`. # # `Unit`\: The published unit is `Count`. # # * HTTPCode_LB_4XX_Count - The number of HTTP # 4XX client error codes that originated from the load balancer. # Client errors are generated when requests are malformed or # incomplete. These requests were not received by the target # instance. This count does not include response codes generated by # the target instances. # # `Statistics`\: The most useful statistic is `Sum`. Note that # `Minimum`, `Maximum`, and `Average` all return `1`. # # `Unit`\: The published unit is `Count`. # # * HTTPCode_LB_5XX_Count - The number of HTTP # 5XX server error codes that originated from the load balancer. # This does not include any response codes generated by the target # instance. This metric is reported if there are no healthy # instances attached to the load balancer, or if the request rate # exceeds the capacity of the instances (spillover) or the load # balancer. # # `Statistics`\: The most useful statistic is `Sum`. Note that # `Minimum`, `Maximum`, and `Average` all return `1`. # # `Unit`\: The published unit is `Count`. # # * InstanceResponseTime - The time elapsed, in # seconds, after the request leaves the load balancer until a # response from the target instance is received. # # `Statistics`\: The most useful statistic is `Average`. # # `Unit`\: The published unit is `Seconds`. # # * RejectedConnectionCount - The number of # connections that were rejected because the load balancer had # reached its maximum number of connections. # # `Statistics`\: The most useful statistic is `Sum`. # # `Unit`\: The published unit is `Count`. # # * RequestCount - The number of requests # processed over IPv4. This count includes only the requests with a # response generated by a target instance of the load balancer. # # `Statistics`\: The most useful statistic is `Sum`. Note that # `Minimum`, `Maximum`, and `Average` all return `1`. # # `Unit`\: The published unit is `Count`. # # * UnhealthyHostCount - The number of target # instances that are considered unhealthy. # # `Statistics`\: The most useful statistic are `Average`, `Minimum`, # and `Maximum`. # # `Unit`\: The published unit is `Count`. # @return [String] # # @!attribute [rw] period # The granularity, in seconds, of the returned data points. # @return [Integer] # # @!attribute [rw] start_time # The start time of the period. # @return [Time] # # @!attribute [rw] end_time # The end time of the period. # @return [Time] # # @!attribute [rw] unit # The unit for the metric data request. Valid units depend on the # metric data being requested. For the valid units with each available # metric, see the `metricName` parameter. # @return [String] # # @!attribute [rw] statistics # The statistic for the metric. # # The following statistics are available: # # * `Minimum` - The lowest value observed during the specified period. # Use this value to determine low volumes of activity for your # application. # # * `Maximum` - The highest value observed during the specified # period. Use this value to determine high volumes of activity for # your application. # # * `Sum` - All values submitted for the matching metric added # together. You can use this statistic to determine the total volume # of a metric. # # * `Average` - The value of Sum / SampleCount during the specified # period. By comparing this statistic with the Minimum and Maximum # values, you can determine the full scope of a metric and how close # the average use is to the Minimum and Maximum values. This # comparison helps you to know when to increase or decrease your # resources. # # * `SampleCount` - The count, or number, of data points used for the # statistical calculation. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetLoadBalancerMetricDataRequest AWS API Documentation # class GetLoadBalancerMetricDataRequest < Struct.new( :load_balancer_name, :metric_name, :period, :start_time, :end_time, :unit, :statistics) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] metric_name # The name of the metric returned. # @return [String] # # @!attribute [rw] metric_data # An array of objects that describe the metric data returned. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetLoadBalancerMetricDataResult AWS API Documentation # class GetLoadBalancerMetricDataResult < Struct.new( :metric_name, :metric_data) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass GetLoadBalancerRequest # data as a hash: # # { # load_balancer_name: "ResourceName", # required # } # # @!attribute [rw] load_balancer_name # The name of the load balancer. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetLoadBalancerRequest AWS API Documentation # class GetLoadBalancerRequest < Struct.new( :load_balancer_name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] load_balancer # An object containing information about your load balancer. # @return [Types::LoadBalancer] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetLoadBalancerResult AWS API Documentation # class GetLoadBalancerResult < Struct.new( :load_balancer) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass GetLoadBalancerTlsCertificatesRequest # data as a hash: # # { # load_balancer_name: "ResourceName", # required # } # # @!attribute [rw] load_balancer_name # The name of the load balancer you associated with your SSL/TLS # certificate. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetLoadBalancerTlsCertificatesRequest AWS API Documentation # class GetLoadBalancerTlsCertificatesRequest < Struct.new( :load_balancer_name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] tls_certificates # An array of LoadBalancerTlsCertificate objects describing your # SSL/TLS certificates. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetLoadBalancerTlsCertificatesResult AWS API Documentation # class GetLoadBalancerTlsCertificatesResult < Struct.new( :tls_certificates) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass GetLoadBalancersRequest # data as a hash: # # { # page_token: "string", # } # # @!attribute [rw] page_token # The token to advance to the next page of results from your request. # # To get a page token, perform an initial `GetLoadBalancers` 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. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetLoadBalancersRequest AWS API Documentation # class GetLoadBalancersRequest < Struct.new( :page_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] load_balancers # An array of LoadBalancer objects describing your load balancers. # @return [Array] # # @!attribute [rw] next_page_token # The token to advance to the next page of results from your request. # # A next page token is not returned if there are no more results to # display. # # To get the next page of results, perform another `GetLoadBalancers` # request and specify the next page token using the `pageToken` # parameter. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetLoadBalancersResult AWS API Documentation # class GetLoadBalancersResult < Struct.new( :load_balancers, :next_page_token) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass GetOperationRequest # data as a hash: # # { # operation_id: "NonEmptyString", # required # } # # @!attribute [rw] operation_id # A GUID used to identify the operation. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetOperationRequest AWS API Documentation # class GetOperationRequest < Struct.new( :operation_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] operation # An array of objects that describe the result of the action, such as # the status of the request, the timestamp of the request, and the # resources affected by the request. # @return [Types::Operation] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetOperationResult AWS API Documentation # class GetOperationResult < Struct.new( :operation) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass GetOperationsForResourceRequest # data as a hash: # # { # resource_name: "ResourceName", # required # page_token: "string", # } # # @!attribute [rw] resource_name # The name of the resource for which you are requesting information. # @return [String] # # @!attribute [rw] page_token # The token to advance to the next page of results from your request. # # To get a page token, perform an initial `GetOperationsForResource` # 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. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetOperationsForResourceRequest AWS API Documentation # class GetOperationsForResourceRequest < Struct.new( :resource_name, :page_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] operations # An array of objects that describe the result of the action, such as # the status of the request, the timestamp of the request, and the # resources affected by the request. # @return [Array] # # @!attribute [rw] next_page_count # (Deprecated) Returns the number of pages of results that remain. # # In releases prior to June 12, 2017, this parameter returned `null` # by the API. It is now deprecated, and the API returns the `next page # token` parameter instead. # # # @return [String] # # @!attribute [rw] next_page_token # The token to advance to the next page of results from your request. # # A next page token is not returned if there are no more results to # display. # # To get the next page of results, perform another # `GetOperationsForResource` request and specify the next page token # using the `pageToken` parameter. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetOperationsForResourceResult AWS API Documentation # class GetOperationsForResourceResult < Struct.new( :operations, :next_page_count, :next_page_token) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass GetOperationsRequest # data as a hash: # # { # page_token: "string", # } # # @!attribute [rw] page_token # The token to advance to the next page of results from your request. # # To get a page token, perform an initial `GetOperations` 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. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetOperationsRequest AWS API Documentation # class GetOperationsRequest < Struct.new( :page_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] operations # An array of objects that describe the result of the action, such as # the status of the request, the timestamp of the request, and the # resources affected by the request. # @return [Array] # # @!attribute [rw] next_page_token # The token to advance to the next page of results from your request. # # A next page token is not returned if there are no more results to # display. # # To get the next page of results, perform another `GetOperations` # request and specify the next page token using the `pageToken` # parameter. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetOperationsResult AWS API Documentation # class GetOperationsResult < Struct.new( :operations, :next_page_token) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass GetRegionsRequest # data as a hash: # # { # include_availability_zones: false, # include_relational_database_availability_zones: false, # } # # @!attribute [rw] include_availability_zones # A Boolean value indicating whether to also include Availability # Zones in your get regions request. Availability Zones are indicated # with a letter: e.g., `us-east-2a`. # @return [Boolean] # # @!attribute [rw] include_relational_database_availability_zones # A Boolean value indicating whether to also include Availability # Zones for databases in your get regions request. Availability Zones # are indicated with a letter (e.g., `us-east-2a`). # @return [Boolean] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRegionsRequest AWS API Documentation # class GetRegionsRequest < Struct.new( :include_availability_zones, :include_relational_database_availability_zones) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] regions # An array of key-value pairs containing information about your get # regions request. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRegionsResult AWS API Documentation # class GetRegionsResult < Struct.new( :regions) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass GetRelationalDatabaseBlueprintsRequest # data as a hash: # # { # page_token: "string", # } # # @!attribute [rw] page_token # The token to advance to the next page of results from your request. # # To get a page token, perform an initial # `GetRelationalDatabaseBlueprints` 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. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabaseBlueprintsRequest AWS API Documentation # class GetRelationalDatabaseBlueprintsRequest < Struct.new( :page_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] blueprints # An object describing the result of your get relational database # blueprints request. # @return [Array] # # @!attribute [rw] next_page_token # The token to advance to the next page of results from your request. # # A next page token is not returned if there are no more results to # display. # # To get the next page of results, perform another # `GetRelationalDatabaseBlueprints` request and specify the next page # token using the `pageToken` parameter. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabaseBlueprintsResult AWS API Documentation # class GetRelationalDatabaseBlueprintsResult < Struct.new( :blueprints, :next_page_token) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass GetRelationalDatabaseBundlesRequest # data as a hash: # # { # page_token: "string", # } # # @!attribute [rw] page_token # The token to advance to the next page of results from your request. # # To get a page token, perform an initial # `GetRelationalDatabaseBundles` 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. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabaseBundlesRequest AWS API Documentation # class GetRelationalDatabaseBundlesRequest < Struct.new( :page_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bundles # An object describing the result of your get relational database # bundles request. # @return [Array] # # @!attribute [rw] next_page_token # The token to advance to the next page of results from your request. # # A next page token is not returned if there are no more results to # display. # # To get the next page of results, perform another # `GetRelationalDatabaseBundles` request and specify the next page # token using the `pageToken` parameter. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabaseBundlesResult AWS API Documentation # class GetRelationalDatabaseBundlesResult < Struct.new( :bundles, :next_page_token) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass GetRelationalDatabaseEventsRequest # data as a hash: # # { # relational_database_name: "ResourceName", # required # duration_in_minutes: 1, # page_token: "string", # } # # @!attribute [rw] relational_database_name # The name of the database from which to get events. # @return [String] # # @!attribute [rw] duration_in_minutes # The number of minutes in the past from which to retrieve events. For # example, to get all events from the past 2 hours, enter 120. # # Default: `60` # # The minimum is 1 and the maximum is 14 days (20160 minutes). # @return [Integer] # # @!attribute [rw] page_token # The token to advance to the next page of results from your request. # # To get a page token, perform an initial # `GetRelationalDatabaseEvents` 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. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabaseEventsRequest AWS API Documentation # class GetRelationalDatabaseEventsRequest < Struct.new( :relational_database_name, :duration_in_minutes, :page_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] relational_database_events # An object describing the result of your get relational database # events request. # @return [Array] # # @!attribute [rw] next_page_token # The token to advance to the next page of results from your request. # # A next page token is not returned if there are no more results to # display. # # To get the next page of results, perform another # `GetRelationalDatabaseEvents` request and specify the next page # token using the `pageToken` parameter. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabaseEventsResult AWS API Documentation # class GetRelationalDatabaseEventsResult < Struct.new( :relational_database_events, :next_page_token) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass GetRelationalDatabaseLogEventsRequest # data as a hash: # # { # relational_database_name: "ResourceName", # required # log_stream_name: "string", # required # start_time: Time.now, # end_time: Time.now, # start_from_head: false, # page_token: "string", # } # # @!attribute [rw] relational_database_name # The name of your database for which to get log events. # @return [String] # # @!attribute [rw] log_stream_name # The name of the log stream. # # Use the `get relational database log streams` operation to get a # list of available log streams. # @return [String] # # @!attribute [rw] start_time # The start of the time interval from which to get log events. # # Constraints: # # * Specified in Coordinated Universal Time (UTC). # # * Specified in the Unix time format. # # For example, if you wish to use a start time of October 1, 2018, # at 8 PM UTC, then you input `1538424000` as the start time. # @return [Time] # # @!attribute [rw] end_time # The end of the time interval from which to get log events. # # Constraints: # # * Specified in Coordinated Universal Time (UTC). # # * Specified in the Unix time format. # # For example, if you wish to use an end time of October 1, 2018, at # 8 PM UTC, then you input `1538424000` as the end time. # @return [Time] # # @!attribute [rw] start_from_head # Parameter to specify if the log should start from head or tail. If # `true` is specified, the log event starts from the head of the log. # If `false` is specified, the log event starts from the tail of the # log. # # For PostgreSQL, the default value of `false` is the only option # available. # # # @return [Boolean] # # @!attribute [rw] page_token # The token to advance to the next or previous page of results from # your request. # # To get a page token, perform an initial # `GetRelationalDatabaseLogEvents` request. If your results are # paginated, the response will return a next forward token and/or next # backward token that you can specify as the page token in a # subsequent request. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabaseLogEventsRequest AWS API Documentation # class GetRelationalDatabaseLogEventsRequest < Struct.new( :relational_database_name, :log_stream_name, :start_time, :end_time, :start_from_head, :page_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] resource_log_events # An object describing the result of your get relational database log # events request. # @return [Array] # # @!attribute [rw] next_backward_token # A token used for advancing to the previous page of results from your # get relational database log events request. # @return [String] # # @!attribute [rw] next_forward_token # A token used for advancing to the next page of results from your get # relational database log events request. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabaseLogEventsResult AWS API Documentation # class GetRelationalDatabaseLogEventsResult < Struct.new( :resource_log_events, :next_backward_token, :next_forward_token) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass GetRelationalDatabaseLogStreamsRequest # data as a hash: # # { # relational_database_name: "ResourceName", # required # } # # @!attribute [rw] relational_database_name # The name of your database for which to get log streams. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabaseLogStreamsRequest AWS API Documentation # class GetRelationalDatabaseLogStreamsRequest < Struct.new( :relational_database_name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] log_streams # An object describing the result of your get relational database log # streams request. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabaseLogStreamsResult AWS API Documentation # class GetRelationalDatabaseLogStreamsResult < Struct.new( :log_streams) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass GetRelationalDatabaseMasterUserPasswordRequest # data as a hash: # # { # relational_database_name: "ResourceName", # required # password_version: "CURRENT", # accepts CURRENT, PREVIOUS, PENDING # } # # @!attribute [rw] relational_database_name # The name of your database for which to get the master user password. # @return [String] # # @!attribute [rw] password_version # The password version to return. # # Specifying `CURRENT` or `PREVIOUS` returns the current or previous # passwords respectively. Specifying `PENDING` returns the newest # version of the password that will rotate to `CURRENT`. After the # `PENDING` password rotates to `CURRENT`, the `PENDING` password is # no longer available. # # Default: `CURRENT` # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabaseMasterUserPasswordRequest AWS API Documentation # class GetRelationalDatabaseMasterUserPasswordRequest < Struct.new( :relational_database_name, :password_version) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] master_user_password # The master user password for the `password version` specified. # @return [String] # # @!attribute [rw] created_at # The timestamp when the specified version of the master user password # was created. # @return [Time] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabaseMasterUserPasswordResult AWS API Documentation # class GetRelationalDatabaseMasterUserPasswordResult < Struct.new( :master_user_password, :created_at) SENSITIVE = [:master_user_password] include Aws::Structure end # @note When making an API call, you may pass GetRelationalDatabaseMetricDataRequest # data as a hash: # # { # relational_database_name: "ResourceName", # required # metric_name: "CPUUtilization", # required, accepts CPUUtilization, DatabaseConnections, DiskQueueDepth, FreeStorageSpace, NetworkReceiveThroughput, NetworkTransmitThroughput # period: 1, # required # start_time: Time.now, # required # end_time: Time.now, # required # unit: "Seconds", # required, accepts Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None # statistics: ["Minimum"], # required, accepts Minimum, Maximum, Sum, Average, SampleCount # } # # @!attribute [rw] relational_database_name # The name of your database from which to get metric data. # @return [String] # # @!attribute [rw] metric_name # The metric for which you want to return information. # # Valid relational database metric names are listed below, along with # the most useful `statistics` to include in your request, and the # published `unit` value. All relational database metric data is # available in 1-minute (60 seconds) granularity. # # * CPUUtilization - The percentage of CPU # utilization currently in use on the database. # # `Statistics`\: The most useful statistics are `Maximum` and # `Average`. # # `Unit`\: The published unit is `Percent`. # # * DatabaseConnections - The number of database # connections in use. # # `Statistics`\: The most useful statistics are `Maximum` and `Sum`. # # `Unit`\: The published unit is `Count`. # # * DiskQueueDepth - The number of outstanding # IOs (read/write requests) that are waiting to access the disk. # # `Statistics`\: The most useful statistic is `Sum`. # # `Unit`\: The published unit is `Count`. # # * FreeStorageSpace - The amount of available # storage space. # # `Statistics`\: The most useful statistic is `Sum`. # # `Unit`\: The published unit is `Bytes`. # # * NetworkReceiveThroughput - The incoming # (Receive) network traffic on the database, including both customer # database traffic and AWS traffic used for monitoring and # replication. # # `Statistics`\: The most useful statistic is `Average`. # # `Unit`\: The published unit is `Bytes/Second`. # # * NetworkTransmitThroughput - The outgoing # (Transmit) network traffic on the database, including both # customer database traffic and AWS traffic used for monitoring and # replication. # # `Statistics`\: The most useful statistic is `Average`. # # `Unit`\: The published unit is `Bytes/Second`. # @return [String] # # @!attribute [rw] period # The granularity, in seconds, of the returned data points. # # All relational database metric data is available in 1-minute (60 # seconds) granularity. # @return [Integer] # # @!attribute [rw] start_time # The start of the time interval from which to get metric data. # # Constraints: # # * Specified in Coordinated Universal Time (UTC). # # * Specified in the Unix time format. # # For example, if you wish to use a start time of October 1, 2018, # at 8 PM UTC, then you input `1538424000` as the start time. # @return [Time] # # @!attribute [rw] end_time # The end of the time interval from which to get metric data. # # Constraints: # # * Specified in Coordinated Universal Time (UTC). # # * Specified in the Unix time format. # # For example, if you wish to use an end time of October 1, 2018, at # 8 PM UTC, then you input `1538424000` as the end time. # @return [Time] # # @!attribute [rw] unit # The unit for the metric data request. Valid units depend on the # metric data being requested. For the valid units with each available # metric, see the `metricName` parameter. # @return [String] # # @!attribute [rw] statistics # The statistic for the metric. # # The following statistics are available: # # * `Minimum` - The lowest value observed during the specified period. # Use this value to determine low volumes of activity for your # application. # # * `Maximum` - The highest value observed during the specified # period. Use this value to determine high volumes of activity for # your application. # # * `Sum` - All values submitted for the matching metric added # together. You can use this statistic to determine the total volume # of a metric. # # * `Average` - The value of Sum / SampleCount during the specified # period. By comparing this statistic with the Minimum and Maximum # values, you can determine the full scope of a metric and how close # the average use is to the Minimum and Maximum values. This # comparison helps you to know when to increase or decrease your # resources. # # * `SampleCount` - The count, or number, of data points used for the # statistical calculation. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabaseMetricDataRequest AWS API Documentation # class GetRelationalDatabaseMetricDataRequest < Struct.new( :relational_database_name, :metric_name, :period, :start_time, :end_time, :unit, :statistics) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] metric_name # The name of the metric returned. # @return [String] # # @!attribute [rw] metric_data # An array of objects that describe the metric data returned. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabaseMetricDataResult AWS API Documentation # class GetRelationalDatabaseMetricDataResult < Struct.new( :metric_name, :metric_data) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass GetRelationalDatabaseParametersRequest # data as a hash: # # { # relational_database_name: "ResourceName", # required # page_token: "string", # } # # @!attribute [rw] relational_database_name # The name of your database for which to get parameters. # @return [String] # # @!attribute [rw] page_token # The token to advance to the next page of results from your request. # # To get a page token, perform an initial # `GetRelationalDatabaseParameters` 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. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabaseParametersRequest AWS API Documentation # class GetRelationalDatabaseParametersRequest < Struct.new( :relational_database_name, :page_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] parameters # An object describing the result of your get relational database # parameters request. # @return [Array] # # @!attribute [rw] next_page_token # The token to advance to the next page of results from your request. # # A next page token is not returned if there are no more results to # display. # # To get the next page of results, perform another # `GetRelationalDatabaseParameters` request and specify the next page # token using the `pageToken` parameter. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabaseParametersResult AWS API Documentation # class GetRelationalDatabaseParametersResult < Struct.new( :parameters, :next_page_token) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass GetRelationalDatabaseRequest # data as a hash: # # { # relational_database_name: "ResourceName", # required # } # # @!attribute [rw] relational_database_name # The name of the database that you are looking up. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabaseRequest AWS API Documentation # class GetRelationalDatabaseRequest < Struct.new( :relational_database_name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] relational_database # An object describing the specified database. # @return [Types::RelationalDatabase] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabaseResult AWS API Documentation # class GetRelationalDatabaseResult < Struct.new( :relational_database) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass GetRelationalDatabaseSnapshotRequest # data as a hash: # # { # relational_database_snapshot_name: "ResourceName", # required # } # # @!attribute [rw] relational_database_snapshot_name # The name of the database snapshot for which to get information. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabaseSnapshotRequest AWS API Documentation # class GetRelationalDatabaseSnapshotRequest < Struct.new( :relational_database_snapshot_name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] relational_database_snapshot # An object describing the specified database snapshot. # @return [Types::RelationalDatabaseSnapshot] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabaseSnapshotResult AWS API Documentation # class GetRelationalDatabaseSnapshotResult < Struct.new( :relational_database_snapshot) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass GetRelationalDatabaseSnapshotsRequest # data as a hash: # # { # page_token: "string", # } # # @!attribute [rw] page_token # The token to advance to the next page of results from your request. # # To get a page token, perform an initial # `GetRelationalDatabaseSnapshots` 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. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabaseSnapshotsRequest AWS API Documentation # class GetRelationalDatabaseSnapshotsRequest < Struct.new( :page_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] relational_database_snapshots # An object describing the result of your get relational database # snapshots request. # @return [Array] # # @!attribute [rw] next_page_token # The token to advance to the next page of results from your request. # # A next page token is not returned if there are no more results to # display. # # To get the next page of results, perform another # `GetRelationalDatabaseSnapshots` request and specify the next page # token using the `pageToken` parameter. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabaseSnapshotsResult AWS API Documentation # class GetRelationalDatabaseSnapshotsResult < Struct.new( :relational_database_snapshots, :next_page_token) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass GetRelationalDatabasesRequest # data as a hash: # # { # page_token: "string", # } # # @!attribute [rw] page_token # The token to advance to the next page of results from your request. # # To get a page token, perform an initial `GetRelationalDatabases` # 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. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabasesRequest AWS API Documentation # class GetRelationalDatabasesRequest < Struct.new( :page_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] relational_databases # An object describing the result of your get relational databases # request. # @return [Array] # # @!attribute [rw] next_page_token # The token to advance to the next page of results from your request. # # A next page token is not returned if there are no more results to # display. # # To get the next page of results, perform another # `GetRelationalDatabases` request and specify the next page token # using the `pageToken` parameter. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabasesResult AWS API Documentation # class GetRelationalDatabasesResult < Struct.new( :relational_databases, :next_page_token) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass GetStaticIpRequest # data as a hash: # # { # static_ip_name: "ResourceName", # required # } # # @!attribute [rw] static_ip_name # The name of the static IP in Lightsail. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetStaticIpRequest AWS API Documentation # class GetStaticIpRequest < Struct.new( :static_ip_name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] static_ip # An array of key-value pairs containing information about the # requested static IP. # @return [Types::StaticIp] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetStaticIpResult AWS API Documentation # class GetStaticIpResult < Struct.new( :static_ip) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass GetStaticIpsRequest # data as a hash: # # { # page_token: "string", # } # # @!attribute [rw] page_token # The token to advance to the next page of results from your request. # # To get a page token, perform an initial `GetStaticIps` 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. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetStaticIpsRequest AWS API Documentation # class GetStaticIpsRequest < Struct.new( :page_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] static_ips # An array of key-value pairs containing information about your get # static IPs request. # @return [Array] # # @!attribute [rw] next_page_token # The token to advance to the next page of results from your request. # # A next page token is not returned if there are no more results to # display. # # To get the next page of results, perform another `GetStaticIps` # request and specify the next page token using the `pageToken` # parameter. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetStaticIpsResult AWS API Documentation # class GetStaticIpsResult < Struct.new( :static_ips, :next_page_token) SENSITIVE = [] include Aws::Structure end # Describes the request headers that a Lightsail distribution bases # caching on. # # For the headers that you specify, your distribution caches separate # versions of the specified content based on the header values in viewer # requests. For example, suppose viewer requests for `logo.jpg` contain # a custom `product` header that has a value of either `acme` or `apex`, # and you configure your distribution to cache your content based on # values in the `product` header. Your distribution forwards the # `product` header to the origin and caches the response from the origin # once for each header value. # # @note When making an API call, you may pass HeaderObject # data as a hash: # # { # option: "none", # accepts none, allow-list, all # headers_allow_list: ["Accept"], # accepts Accept, Accept-Charset, Accept-Datetime, Accept-Encoding, Accept-Language, Authorization, CloudFront-Forwarded-Proto, CloudFront-Is-Desktop-Viewer, CloudFront-Is-Mobile-Viewer, CloudFront-Is-SmartTV-Viewer, CloudFront-Is-Tablet-Viewer, CloudFront-Viewer-Country, Host, Origin, Referer # } # # @!attribute [rw] option # The headers that you want your distribution to forward to your # origin and base caching on. # # You can configure your distribution to do one of the following: # # * all - Forward all headers to your origin. # # * none - Forward only the default headers. # # * allow-list - Forward only the headers you # specify using the `headersAllowList` parameter. # @return [String] # # @!attribute [rw] headers_allow_list # The specific headers to forward to your distribution's origin. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/HeaderObject AWS API Documentation # class HeaderObject < Struct.new( :option, :headers_allow_list) SENSITIVE = [] include Aws::Structure end # Describes the public SSH host keys or the RDP certificate. # # @!attribute [rw] algorithm # The SSH host key algorithm or the RDP certificate format. # # For SSH host keys, the algorithm may be `ssh-rsa`, # `ecdsa-sha2-nistp256`, `ssh-ed25519`, etc. For RDP certificates, the # algorithm is always `x509-cert`. # @return [String] # # @!attribute [rw] public_key # The public SSH host key or the RDP certificate. # @return [String] # # @!attribute [rw] witnessed_at # The time that the SSH host key or RDP certificate was recorded by # Lightsail. # @return [Time] # # @!attribute [rw] fingerprint_sha1 # The SHA-1 fingerprint of the returned SSH host key or RDP # certificate. # # * Example of an SHA-1 SSH fingerprint: # # `SHA1:1CHH6FaAaXjtFOsR/t83vf91SR0` # # * Example of an SHA-1 RDP fingerprint: # # `af:34:51:fe:09:f0:e0:da:b8:4e:56:ca:60:c2:10:ff:38:06:db:45` # @return [String] # # @!attribute [rw] fingerprint_sha256 # The SHA-256 fingerprint of the returned SSH host key or RDP # certificate. # # * Example of an SHA-256 SSH fingerprint: # # `SHA256:KTsMnRBh1IhD17HpdfsbzeGA4jOijm5tyXsMjKVbB8o` # # * Example of an SHA-256 RDP fingerprint: # # `03:9b:36:9f:4b:de:4e:61:70:fc:7c:c9:78:e7:d2:1a:1c:25:a8:0c:91:f6:7c:e4:d6:a0:85:c8:b4:53:99:68` # @return [String] # # @!attribute [rw] not_valid_before # The returned RDP certificate is valid after this point in time. # # This value is listed only for RDP certificates. # @return [Time] # # @!attribute [rw] not_valid_after # The returned RDP certificate is not valid after this point in time. # # This value is listed only for RDP certificates. # @return [Time] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/HostKeyAttributes AWS API Documentation # class HostKeyAttributes < Struct.new( :algorithm, :public_key, :witnessed_at, :fingerprint_sha1, :fingerprint_sha256, :not_valid_before, :not_valid_after) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass ImportKeyPairRequest # data as a hash: # # { # key_pair_name: "ResourceName", # required # public_key_base_64: "Base64", # required # } # # @!attribute [rw] key_pair_name # The name of the key pair for which you want to import the public # key. # @return [String] # # @!attribute [rw] public_key_base_64 # A base64-encoded public key of the `ssh-rsa` type. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/ImportKeyPairRequest AWS API Documentation # class ImportKeyPairRequest < Struct.new( :key_pair_name, :public_key_base_64) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] operation # An array of objects that describe the result of the action, such as # the status of the request, the timestamp of the request, and the # resources affected by the request. # @return [Types::Operation] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/ImportKeyPairResult AWS API Documentation # class ImportKeyPairResult < Struct.new( :operation) SENSITIVE = [] include Aws::Structure end # Describes the origin resource of an Amazon Lightsail content delivery # network (CDN) distribution. # # An origin can be a Lightsail instance or load balancer. A distribution # pulls content from an origin, caches it, and serves it to viewers via # a worldwide network of edge servers. # # @note When making an API call, you may pass InputOrigin # data as a hash: # # { # name: "ResourceName", # region_name: "us-east-1", # accepts us-east-1, us-east-2, us-west-1, us-west-2, eu-west-1, eu-west-2, eu-west-3, eu-central-1, ca-central-1, ap-south-1, ap-southeast-1, ap-southeast-2, ap-northeast-1, ap-northeast-2, eu-north-1 # protocol_policy: "http-only", # accepts http-only, https-only # } # # @!attribute [rw] name # The name of the origin resource. # @return [String] # # @!attribute [rw] region_name # The AWS Region name of the origin resource. # @return [String] # # @!attribute [rw] protocol_policy # The protocol that your Amazon Lightsail distribution uses when # establishing a connection with your origin to pull content. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/InputOrigin AWS API Documentation # class InputOrigin < Struct.new( :name, :region_name, :protocol_policy) SENSITIVE = [] include Aws::Structure end # Describes an instance (a virtual private server). # # @!attribute [rw] name # The name the user gave the instance (e.g., # `Amazon_Linux-1GB-Ohio-1`). # @return [String] # # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the instance (e.g., # `arn:aws:lightsail:us-east-2:123456789101:Instance/244ad76f-8aad-4741-809f-12345EXAMPLE`). # @return [String] # # @!attribute [rw] support_code # The support code. Include this code in your email to support when # you have questions about an instance or another resource in # Lightsail. This code enables our support team to look up your # Lightsail information more easily. # @return [String] # # @!attribute [rw] created_at # The timestamp when the instance was created (e.g., `1479734909.17`) # in Unix time format. # @return [Time] # # @!attribute [rw] location # The region name and Availability Zone where the instance is located. # @return [Types::ResourceLocation] # # @!attribute [rw] resource_type # The type of resource (usually `Instance`). # @return [String] # # @!attribute [rw] tags # The tag keys and optional values for the resource. For more # information about tags in Lightsail, see the [Amazon Lightsail # Developer Guide][1]. # # # # [1]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags # @return [Array] # # @!attribute [rw] blueprint_id # The blueprint ID (e.g., `os_amlinux_2016_03`). # @return [String] # # @!attribute [rw] blueprint_name # The friendly name of the blueprint (e.g., `Amazon Linux`). # @return [String] # # @!attribute [rw] bundle_id # The bundle for the instance (e.g., `micro_1_0`). # @return [String] # # @!attribute [rw] add_ons # An array of objects representing the add-ons enabled on the # instance. # @return [Array] # # @!attribute [rw] is_static_ip # A Boolean value indicating whether this instance has a static IP # assigned to it. # @return [Boolean] # # @!attribute [rw] private_ip_address # The private IP address of the instance. # @return [String] # # @!attribute [rw] public_ip_address # The public IP address of the instance. # @return [String] # # @!attribute [rw] ipv6_addresses # The IPv6 addresses of the instance. # @return [Array] # # @!attribute [rw] ip_address_type # The IP address type of the instance. # # The possible values are `ipv4` for IPv4 only, and `dualstack` for # IPv4 and IPv6. # @return [String] # # @!attribute [rw] hardware # The size of the vCPU and the amount of RAM for the instance. # @return [Types::InstanceHardware] # # @!attribute [rw] networking # Information about the public ports and monthly data transfer rates # for the instance. # @return [Types::InstanceNetworking] # # @!attribute [rw] state # The status code and the state (e.g., `running`) for the instance. # @return [Types::InstanceState] # # @!attribute [rw] username # The user name for connecting to the instance (e.g., `ec2-user`). # @return [String] # # @!attribute [rw] ssh_key_name # The name of the SSH key being used to connect to the instance (e.g., # `LightsailDefaultKeyPair`). # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/Instance AWS API Documentation # class Instance < Struct.new( :name, :arn, :support_code, :created_at, :location, :resource_type, :tags, :blueprint_id, :blueprint_name, :bundle_id, :add_ons, :is_static_ip, :private_ip_address, :public_ip_address, :ipv6_addresses, :ip_address_type, :hardware, :networking, :state, :username, :ssh_key_name) SENSITIVE = [] include Aws::Structure end # The parameters for gaining temporary access to one of your Amazon # Lightsail instances. # # @!attribute [rw] cert_key # For SSH access, the public key to use when accessing your instance # For OpenSSH clients (e.g., command line SSH), you should save this # value to `tempkey-cert.pub`. # @return [String] # # @!attribute [rw] expires_at # For SSH access, the date on which the temporary keys expire. # @return [Time] # # @!attribute [rw] ip_address # The public IP address of the Amazon Lightsail instance. # @return [String] # # @!attribute [rw] password # For RDP access, the password for your Amazon Lightsail instance. # Password will be an empty string if the password for your new # instance is not ready yet. When you create an instance, it can take # up to 15 minutes for the instance to be ready. # # If you create an instance using any key pair other than the default # (`LightsailDefaultKeyPair`), `password` will always be an empty # string. # # If you change the Administrator password on the instance, Lightsail # will continue to return the original password value. When accessing # the instance using RDP, you need to manually enter the Administrator # password after changing it from the default. # # # @return [String] # # @!attribute [rw] password_data # For a Windows Server-based instance, an object with the data you can # use to retrieve your password. This is only needed if `password` is # empty and the instance is not new (and therefore the password is not # ready yet). When you create an instance, it can take up to 15 # minutes for the instance to be ready. # @return [Types::PasswordData] # # @!attribute [rw] private_key # For SSH access, the temporary private key. For OpenSSH clients # (e.g., command line SSH), you should save this value to `tempkey`). # @return [String] # # @!attribute [rw] protocol # The protocol for these Amazon Lightsail instance access details. # @return [String] # # @!attribute [rw] instance_name # The name of this Amazon Lightsail instance. # @return [String] # # @!attribute [rw] username # The user name to use when logging in to the Amazon Lightsail # instance. # @return [String] # # @!attribute [rw] host_keys # Describes the public SSH host keys or the RDP certificate. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/InstanceAccessDetails AWS API Documentation # class InstanceAccessDetails < Struct.new( :cert_key, :expires_at, :ip_address, :password, :password_data, :private_key, :protocol, :instance_name, :username, :host_keys) SENSITIVE = [] include Aws::Structure end # Describes the Amazon Elastic Compute Cloud instance and related # resources to be created using the `create cloud formation stack` # operation. # # @note When making an API call, you may pass InstanceEntry # data as a hash: # # { # source_name: "ResourceName", # required # instance_type: "NonEmptyString", # required # port_info_source: "DEFAULT", # required, accepts DEFAULT, INSTANCE, NONE, CLOSED # user_data: "string", # availability_zone: "string", # required # } # # @!attribute [rw] source_name # The name of the export snapshot record, which contains the exported # Lightsail instance snapshot that will be used as the source of the # new Amazon EC2 instance. # # Use the `get export snapshot records` operation to get a list of # export snapshot records that you can use to create a CloudFormation # stack. # @return [String] # # @!attribute [rw] instance_type # The instance type (e.g., `t2.micro`) to use for the new Amazon EC2 # instance. # @return [String] # # @!attribute [rw] port_info_source # The port configuration to use for the new Amazon EC2 instance. # # The following configuration options are available: # # * `DEFAULT` - Use the default firewall settings from the Lightsail # instance blueprint. If this is specified, then IPv4 and IPv6 will # be configured for the new instance that is created in Amazon EC2. # # * `INSTANCE` - Use the configured firewall settings from the source # Lightsail instance. If this is specified, the new instance that is # created in Amazon EC2 will be configured to match the # configuration of the source Lightsail instance. For example, if # the source instance is configured for dual-stack (IPv4 and IPv6), # then IPv4 and IPv6 will be configured for the new instance that is # created in Amazon EC2. If the source instance is configured for # IPv4 only, then only IPv4 will be configured for the new instance # that is created in Amazon EC2. # # * `NONE` - Use the default Amazon EC2 security group. If this is # specified, then only IPv4 will be configured for the new instance # that is created in Amazon EC2. # # * `CLOSED` - All ports closed. If this is specified, then only IPv4 # will be configured for the new instance that is created in Amazon # EC2. # # If you configured `lightsail-connect` as a `cidrListAliases` on your # instance, or if you chose to allow the Lightsail browser-based SSH # or RDP clients to connect to your instance, that configuration is # not carried over to your new Amazon EC2 instance. # # # @return [String] # # @!attribute [rw] user_data # A launch script you can create that configures a server with # additional user data. For example, you might want to run `apt-get -y # update`. # # Depending on the machine image you choose, the command to get # software on your instance varies. Amazon Linux and CentOS use `yum`, # Debian and Ubuntu use `apt-get`, and FreeBSD uses `pkg`. # # # @return [String] # # @!attribute [rw] availability_zone # The Availability Zone for the new Amazon EC2 instance. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/InstanceEntry AWS API Documentation # class InstanceEntry < Struct.new( :source_name, :instance_type, :port_info_source, :user_data, :availability_zone) SENSITIVE = [] include Aws::Structure end # Describes the hardware for the instance. # # @!attribute [rw] cpu_count # The number of vCPUs the instance has. # @return [Integer] # # @!attribute [rw] disks # The disks attached to the instance. # @return [Array] # # @!attribute [rw] ram_size_in_gb # The amount of RAM in GB on the instance (e.g., `1.0`). # @return [Float] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/InstanceHardware AWS API Documentation # class InstanceHardware < Struct.new( :cpu_count, :disks, :ram_size_in_gb) SENSITIVE = [] include Aws::Structure end # Describes information about the health of the instance. # # @!attribute [rw] instance_name # The name of the Lightsail instance for which you are requesting # health check data. # @return [String] # # @!attribute [rw] instance_health # Describes the overall instance health. Valid values are below. # @return [String] # # @!attribute [rw] instance_health_reason # More information about the instance health. If the `instanceHealth` # is `healthy`, then an `instanceHealthReason` value is not provided. # # If instanceHealth is `initial`, the # instanceHealthReason value can be one of the # following: # # * Lb.RegistrationInProgress - The target # instance is in the process of being registered with the load # balancer. # # * Lb.InitialHealthChecking - The Lightsail # load balancer is still sending the target instance the minimum # number of health checks required to determine its health status. # # If instanceHealth is `unhealthy`, the # instanceHealthReason value can be one of the # following: # # * Instance.ResponseCodeMismatch - The health # checks did not return an expected HTTP code. # # * Instance.Timeout - The health check requests # timed out. # # * Instance.FailedHealthChecks - The health # checks failed because the connection to the target instance timed # out, the target instance response was malformed, or the target # instance failed the health check for an unknown reason. # # * Lb.InternalError - The health checks failed # due to an internal error. # # If instanceHealth is `unused`, the # instanceHealthReason value can be one of the # following: # # * Instance.NotRegistered - The target instance # is not registered with the target group. # # * Instance.NotInUse - The target group is not # used by any load balancer, or the target instance is in an # Availability Zone that is not enabled for its load balancer. # # * Instance.IpUnusable - The target IP address # is reserved for use by a Lightsail load balancer. # # * Instance.InvalidState - The target is in the # stopped or terminated state. # # If instanceHealth is `draining`, the # instanceHealthReason value can be one of the # following: # # * Instance.DeregistrationInProgress - The # target instance is in the process of being deregistered and the # deregistration delay period has not expired. # # ^ # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/InstanceHealthSummary AWS API Documentation # class InstanceHealthSummary < Struct.new( :instance_name, :instance_health, :instance_health_reason) SENSITIVE = [] include Aws::Structure end # Describes monthly data transfer rates and port information for an # instance. # # @!attribute [rw] monthly_transfer # The amount of data in GB allocated for monthly data transfers. # @return [Types::MonthlyTransfer] # # @!attribute [rw] ports # An array of key-value pairs containing information about the ports # on the instance. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/InstanceNetworking AWS API Documentation # class InstanceNetworking < Struct.new( :monthly_transfer, :ports) SENSITIVE = [] include Aws::Structure end # Describes information about ports for an Amazon Lightsail instance. # # @!attribute [rw] from_port # The first port in a range of open ports on an instance. # # Allowed ports: # # * TCP and UDP - `0` to `65535` # # * ICMP - The ICMP type for IPv4 addresses. For example, specify `8` # as the `fromPort` (ICMP type), and `-1` as the `toPort` (ICMP # code), to enable ICMP Ping. For more information, see [Control # Messages][1] on *Wikipedia*. # # * ICMPv6 - The ICMP type for IPv6 addresses. For example, specify # `128` as the `fromPort` (ICMPv6 type), and `0` as `toPort` (ICMPv6 # code). For more information, see [Internet Control Message # Protocol for IPv6][2]. # # # # [1]: https://en.wikipedia.org/wiki/Internet_Control_Message_Protocol#Control_messages # [2]: https://en.wikipedia.org/wiki/Internet_Control_Message_Protocol_for_IPv6 # @return [Integer] # # @!attribute [rw] to_port # The last port in a range of open ports on an instance. # # Allowed ports: # # * TCP and UDP - `0` to `65535` # # * ICMP - The ICMP code for IPv4 addresses. For example, specify `8` # as the `fromPort` (ICMP type), and `-1` as the `toPort` (ICMP # code), to enable ICMP Ping. For more information, see [Control # Messages][1] on *Wikipedia*. # # * ICMPv6 - The ICMP code for IPv6 addresses. For example, specify # `128` as the `fromPort` (ICMPv6 type), and `0` as `toPort` (ICMPv6 # code). For more information, see [Internet Control Message # Protocol for IPv6][2]. # # # # [1]: https://en.wikipedia.org/wiki/Internet_Control_Message_Protocol#Control_messages # [2]: https://en.wikipedia.org/wiki/Internet_Control_Message_Protocol_for_IPv6 # @return [Integer] # # @!attribute [rw] protocol # The IP protocol name. # # The name can be one of the following: # # * `tcp` - Transmission Control Protocol (TCP) provides reliable, # ordered, and error-checked delivery of streamed data between # applications running on hosts communicating by an IP network. If # you have an application that doesn't require reliable data stream # service, use UDP instead. # # * `all` - All transport layer protocol types. For more general # information, see [Transport layer][1] on *Wikipedia*. # # * `udp` - With User Datagram Protocol (UDP), computer applications # can send messages (or datagrams) to other hosts on an Internet # Protocol (IP) network. Prior communications are not required to # set up transmission channels or data paths. Applications that # don't require reliable data stream service can use UDP, which # provides a connectionless datagram service that emphasizes reduced # latency over reliability. If you do require reliable data stream # service, use TCP instead. # # * `icmp` - Internet Control Message Protocol (ICMP) is used to send # error messages and operational information indicating success or # failure when communicating with an instance. For example, an error # is indicated when an instance could not be reached. When you # specify `icmp` as the `protocol`, you must specify the ICMP type # using the `fromPort` parameter, and ICMP code using the `toPort` # parameter. # # # # [1]: https://en.wikipedia.org/wiki/Transport_layer # @return [String] # # @!attribute [rw] access_from # The location from which access is allowed. For example, `Anywhere # (0.0.0.0/0)`, or `Custom` if a specific IP address or range of IP # addresses is allowed. # @return [String] # # @!attribute [rw] access_type # The type of access (`Public` or `Private`). # @return [String] # # @!attribute [rw] common_name # The common name of the port information. # @return [String] # # @!attribute [rw] access_direction # The access direction (`inbound` or `outbound`). # # Lightsail currently supports only `inbound` access direction. # # # @return [String] # # @!attribute [rw] cidrs # The IPv4 address, or range of IPv4 addresses (in CIDR notation) that # are allowed to connect to an instance through the ports, and the # protocol. # # The `ipv6Cidrs` parameter lists the IPv6 addresses that are allowed # to connect to an instance. # # # # For more information about CIDR block notation, see [Classless # Inter-Domain Routing][1] on *Wikipedia*. # # # # [1]: https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing#CIDR_notation # @return [Array] # # @!attribute [rw] ipv6_cidrs # The IPv6 address, or range of IPv6 addresses (in CIDR notation) that # are allowed to connect to an instance through the ports, and the # protocol. Only devices with an IPv6 address can connect to an # instance through IPv6; otherwise, IPv4 should be used. # # The `cidrs` parameter lists the IPv4 addresses that are allowed to # connect to an instance. # # # # For more information about CIDR block notation, see [Classless # Inter-Domain Routing][1] on *Wikipedia*. # # # # [1]: https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing#CIDR_notation # @return [Array] # # @!attribute [rw] cidr_list_aliases # An alias that defines access for a preconfigured range of IP # addresses. # # The only alias currently supported is `lightsail-connect`, which # allows IP addresses of the browser-based RDP/SSH client in the # Lightsail console to connect to your instance. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/InstancePortInfo AWS API Documentation # class InstancePortInfo < Struct.new( :from_port, :to_port, :protocol, :access_from, :access_type, :common_name, :access_direction, :cidrs, :ipv6_cidrs, :cidr_list_aliases) SENSITIVE = [] include Aws::Structure end # Describes open ports on an instance, the IP addresses allowed to # connect to the instance through the ports, and the protocol. # # @!attribute [rw] from_port # The first port in a range of open ports on an instance. # # Allowed ports: # # * TCP and UDP - `0` to `65535` # # * ICMP - The ICMP type for IPv4 addresses. For example, specify `8` # as the `fromPort` (ICMP type), and `-1` as the `toPort` (ICMP # code), to enable ICMP Ping. For more information, see [Control # Messages][1] on *Wikipedia*. # # * ICMPv6 - The ICMP type for IPv6 addresses. For example, specify # `128` as the `fromPort` (ICMPv6 type), and `0` as `toPort` (ICMPv6 # code). For more information, see [Internet Control Message # Protocol for IPv6][2]. # # # # [1]: https://en.wikipedia.org/wiki/Internet_Control_Message_Protocol#Control_messages # [2]: https://en.wikipedia.org/wiki/Internet_Control_Message_Protocol_for_IPv6 # @return [Integer] # # @!attribute [rw] to_port # The last port in a range of open ports on an instance. # # Allowed ports: # # * TCP and UDP - `0` to `65535` # # * ICMP - The ICMP code for IPv4 addresses. For example, specify `8` # as the `fromPort` (ICMP type), and `-1` as the `toPort` (ICMP # code), to enable ICMP Ping. For more information, see [Control # Messages][1] on *Wikipedia*. # # * ICMPv6 - The ICMP code for IPv6 addresses. For example, specify # `128` as the `fromPort` (ICMPv6 type), and `0` as `toPort` (ICMPv6 # code). For more information, see [Internet Control Message # Protocol for IPv6][2]. # # # # [1]: https://en.wikipedia.org/wiki/Internet_Control_Message_Protocol#Control_messages # [2]: https://en.wikipedia.org/wiki/Internet_Control_Message_Protocol_for_IPv6 # @return [Integer] # # @!attribute [rw] protocol # The IP protocol name. # # The name can be one of the following: # # * `tcp` - Transmission Control Protocol (TCP) provides reliable, # ordered, and error-checked delivery of streamed data between # applications running on hosts communicating by an IP network. If # you have an application that doesn't require reliable data stream # service, use UDP instead. # # * `all` - All transport layer protocol types. For more general # information, see [Transport layer][1] on *Wikipedia*. # # * `udp` - With User Datagram Protocol (UDP), computer applications # can send messages (or datagrams) to other hosts on an Internet # Protocol (IP) network. Prior communications are not required to # set up transmission channels or data paths. Applications that # don't require reliable data stream service can use UDP, which # provides a connectionless datagram service that emphasizes reduced # latency over reliability. If you do require reliable data stream # service, use TCP instead. # # * `icmp` - Internet Control Message Protocol (ICMP) is used to send # error messages and operational information indicating success or # failure when communicating with an instance. For example, an error # is indicated when an instance could not be reached. When you # specify `icmp` as the `protocol`, you must specify the ICMP type # using the `fromPort` parameter, and ICMP code using the `toPort` # parameter. # # # # [1]: https://en.wikipedia.org/wiki/Transport_layer # @return [String] # # @!attribute [rw] state # Specifies whether the instance port is `open` or `closed`. # # The port state for Lightsail instances is always `open`. # # # @return [String] # # @!attribute [rw] cidrs # The IPv4 address, or range of IPv4 addresses (in CIDR notation) that # are allowed to connect to an instance through the ports, and the # protocol. # # The `ipv6Cidrs` parameter lists the IPv6 addresses that are allowed # to connect to an instance. # # # # For more information about CIDR block notation, see [Classless # Inter-Domain Routing][1] on *Wikipedia*. # # # # [1]: https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing#CIDR_notation # @return [Array] # # @!attribute [rw] ipv6_cidrs # The IPv6 address, or range of IPv6 addresses (in CIDR notation) that # are allowed to connect to an instance through the ports, and the # protocol. Only devices with an IPv6 address can connect to an # instance through IPv6; otherwise, IPv4 should be used. # # The `cidrs` parameter lists the IPv4 addresses that are allowed to # connect to an instance. # # # # For more information about CIDR block notation, see [Classless # Inter-Domain Routing][1] on *Wikipedia*. # # # # [1]: https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing#CIDR_notation # @return [Array] # # @!attribute [rw] cidr_list_aliases # An alias that defines access for a preconfigured range of IP # addresses. # # The only alias currently supported is `lightsail-connect`, which # allows IP addresses of the browser-based RDP/SSH client in the # Lightsail console to connect to your instance. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/InstancePortState AWS API Documentation # class InstancePortState < Struct.new( :from_port, :to_port, :protocol, :state, :cidrs, :ipv6_cidrs, :cidr_list_aliases) SENSITIVE = [] include Aws::Structure end # Describes an instance snapshot. # # @!attribute [rw] name # The name of the snapshot. # @return [String] # # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the snapshot (e.g., # `arn:aws:lightsail:us-east-2:123456789101:InstanceSnapshot/d23b5706-3322-4d83-81e5-12345EXAMPLE`). # @return [String] # # @!attribute [rw] support_code # The support code. Include this code in your email to support when # you have questions about an instance or another resource in # Lightsail. This code enables our support team to look up your # Lightsail information more easily. # @return [String] # # @!attribute [rw] created_at # The timestamp when the snapshot was created (e.g., # `1479907467.024`). # @return [Time] # # @!attribute [rw] location # The region name and Availability Zone where you created the # snapshot. # @return [Types::ResourceLocation] # # @!attribute [rw] resource_type # The type of resource (usually `InstanceSnapshot`). # @return [String] # # @!attribute [rw] tags # The tag keys and optional values for the resource. For more # information about tags in Lightsail, see the [Amazon Lightsail # Developer Guide][1]. # # # # [1]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags # @return [Array] # # @!attribute [rw] state # The state the snapshot is in. # @return [String] # # @!attribute [rw] progress # The progress of the snapshot. # # This is populated only for disk snapshots, and is `null` for # instance snapshots. # # # @return [String] # # @!attribute [rw] from_attached_disks # An array of disk objects containing information about all block # storage disks. # @return [Array] # # @!attribute [rw] from_instance_name # The instance from which the snapshot was created. # @return [String] # # @!attribute [rw] from_instance_arn # The Amazon Resource Name (ARN) of the instance from which the # snapshot was created (e.g., # `arn:aws:lightsail:us-east-2:123456789101:Instance/64b8404c-ccb1-430b-8daf-12345EXAMPLE`). # @return [String] # # @!attribute [rw] from_blueprint_id # The blueprint ID from which you created the snapshot (e.g., # `os_debian_8_3`). A blueprint is a virtual private server (or # *instance*) image used to create instances quickly. # @return [String] # # @!attribute [rw] from_bundle_id # The bundle ID from which you created the snapshot (e.g., # `micro_1_0`). # @return [String] # # @!attribute [rw] is_from_auto_snapshot # A Boolean value indicating whether the snapshot was created from an # automatic snapshot. # @return [Boolean] # # @!attribute [rw] size_in_gb # The size in GB of the SSD. # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/InstanceSnapshot AWS API Documentation # class InstanceSnapshot < Struct.new( :name, :arn, :support_code, :created_at, :location, :resource_type, :tags, :state, :progress, :from_attached_disks, :from_instance_name, :from_instance_arn, :from_blueprint_id, :from_bundle_id, :is_from_auto_snapshot, :size_in_gb) SENSITIVE = [] include Aws::Structure end # Describes an instance snapshot. # # @!attribute [rw] from_bundle_id # The bundle ID from which the source instance was created (e.g., # `micro_1_0`). # @return [String] # # @!attribute [rw] from_blueprint_id # The blueprint ID from which the source instance (e.g., # `os_debian_8_3`). # @return [String] # # @!attribute [rw] from_disk_info # A list of objects describing the disks that were attached to the # source instance. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/InstanceSnapshotInfo AWS API Documentation # class InstanceSnapshotInfo < Struct.new( :from_bundle_id, :from_blueprint_id, :from_disk_info) SENSITIVE = [] include Aws::Structure end # Describes the virtual private server (or *instance*) status. # # @!attribute [rw] code # The status code for the instance. # @return [Integer] # # @!attribute [rw] name # The state of the instance (e.g., `running` or `pending`). # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/InstanceState AWS API Documentation # class InstanceState < Struct.new( :code, :name) SENSITIVE = [] include Aws::Structure end # Lightsail throws this exception when user input does not conform to # the validation rules of an input field. # # Domain and distribution APIs are only available in the N. Virginia # (`us-east-1`) AWS Region. Please set your AWS Region configuration to # `us-east-1` to create, view, or edit these resources. # # # # @!attribute [rw] code # @return [String] # # @!attribute [rw] docs # @return [String] # # @!attribute [rw] message # @return [String] # # @!attribute [rw] tip # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/InvalidInputException AWS API Documentation # class InvalidInputException < Struct.new( :code, :docs, :message, :tip) SENSITIVE = [] include Aws::Structure end # @api private # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/IsVpcPeeredRequest AWS API Documentation # class IsVpcPeeredRequest < Aws::EmptyStructure; end # @!attribute [rw] is_peered # Returns `true` if the Lightsail VPC is peered; otherwise, `false`. # @return [Boolean] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/IsVpcPeeredResult AWS API Documentation # class IsVpcPeeredResult < Struct.new( :is_peered) SENSITIVE = [] include Aws::Structure end # Describes an SSH key pair. # # @!attribute [rw] name # The friendly name of the SSH key pair. # @return [String] # # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the key pair (e.g., # `arn:aws:lightsail:us-east-2:123456789101:KeyPair/05859e3d-331d-48ba-9034-12345EXAMPLE`). # @return [String] # # @!attribute [rw] support_code # The support code. Include this code in your email to support when # you have questions about an instance or another resource in # Lightsail. This code enables our support team to look up your # Lightsail information more easily. # @return [String] # # @!attribute [rw] created_at # The timestamp when the key pair was created (e.g., # `1479816991.349`). # @return [Time] # # @!attribute [rw] location # The region name and Availability Zone where the key pair was # created. # @return [Types::ResourceLocation] # # @!attribute [rw] resource_type # The resource type (usually `KeyPair`). # @return [String] # # @!attribute [rw] tags # The tag keys and optional values for the resource. For more # information about tags in Lightsail, see the [Amazon Lightsail # Developer Guide][1]. # # # # [1]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags # @return [Array] # # @!attribute [rw] fingerprint # The RSA fingerprint of the key pair. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/KeyPair AWS API Documentation # class KeyPair < Struct.new( :name, :arn, :support_code, :created_at, :location, :resource_type, :tags, :fingerprint) SENSITIVE = [] include Aws::Structure end # Describes an Amazon Lightsail content delivery network (CDN) # distribution. # # @!attribute [rw] name # The name of the distribution. # @return [String] # # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the distribution. # @return [String] # # @!attribute [rw] support_code # The support code. Include this code in your email to support when # you have questions about your Lightsail distribution. This code # enables our support team to look up your Lightsail information more # easily. # @return [String] # # @!attribute [rw] created_at # The timestamp when the distribution was created. # @return [Time] # # @!attribute [rw] location # An object that describes the location of the distribution, such as # the AWS Region and Availability Zone. # # Lightsail distributions are global resources that can reference an # origin in any AWS Region, and distribute its content globally. # However, all distributions are located in the `us-east-1` Region. # # # @return [Types::ResourceLocation] # # @!attribute [rw] resource_type # The Lightsail resource type (e.g., `Distribution`). # @return [String] # # @!attribute [rw] alternative_domain_names # The alternate domain names of the distribution. # @return [Array] # # @!attribute [rw] status # The status of the distribution. # @return [String] # # @!attribute [rw] is_enabled # Indicates whether the distribution is enabled. # @return [Boolean] # # @!attribute [rw] domain_name # The domain name of the distribution. # @return [String] # # @!attribute [rw] bundle_id # The ID of the bundle currently applied to the distribution. # @return [String] # # @!attribute [rw] certificate_name # The name of the SSL/TLS certificate attached to the distribution, if # any. # @return [String] # # @!attribute [rw] origin # An object that describes the origin resource of the distribution, # such as a Lightsail instance or load balancer. # # The distribution pulls, caches, and serves content from the origin. # @return [Types::Origin] # # @!attribute [rw] origin_public_dns # The public DNS of the origin. # @return [String] # # @!attribute [rw] default_cache_behavior # An object that describes the default cache behavior of the # distribution. # @return [Types::CacheBehavior] # # @!attribute [rw] cache_behavior_settings # An object that describes the cache behavior settings of the # distribution. # @return [Types::CacheSettings] # # @!attribute [rw] cache_behaviors # An array of objects that describe the per-path cache behavior of the # distribution. # @return [Array] # # @!attribute [rw] able_to_update_bundle # Indicates whether the bundle that is currently applied to your # distribution, specified using the `distributionName` parameter, can # be changed to another bundle. # # Use the `UpdateDistributionBundle` action to change your # distribution's bundle. # @return [Boolean] # # @!attribute [rw] ip_address_type # The IP address type of the distribution. # # The possible values are `ipv4` for IPv4 only, and `dualstack` for # IPv4 and IPv6. # @return [String] # # @!attribute [rw] tags # The tag keys and optional values for the resource. For more # information about tags in Lightsail, see the [Amazon Lightsail # Developer Guide][1]. # # # # [1]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/LightsailDistribution AWS API Documentation # class LightsailDistribution < Struct.new( :name, :arn, :support_code, :created_at, :location, :resource_type, :alternative_domain_names, :status, :is_enabled, :domain_name, :bundle_id, :certificate_name, :origin, :origin_public_dns, :default_cache_behavior, :cache_behavior_settings, :cache_behaviors, :able_to_update_bundle, :ip_address_type, :tags) SENSITIVE = [] include Aws::Structure end # Describes a load balancer. # # @!attribute [rw] name # The name of the load balancer (e.g., `my-load-balancer`). # @return [String] # # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the load balancer. # @return [String] # # @!attribute [rw] support_code # The support code. Include this code in your email to support when # you have questions about your Lightsail load balancer. This code # enables our support team to look up your Lightsail information more # easily. # @return [String] # # @!attribute [rw] created_at # The date when your load balancer was created. # @return [Time] # # @!attribute [rw] location # The AWS Region where your load balancer was created (e.g., # `us-east-2a`). Lightsail automatically creates your load balancer # across Availability Zones. # @return [Types::ResourceLocation] # # @!attribute [rw] resource_type # The resource type (e.g., `LoadBalancer`. # @return [String] # # @!attribute [rw] tags # The tag keys and optional values for the resource. For more # information about tags in Lightsail, see the [Amazon Lightsail # Developer Guide][1]. # # # # [1]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags # @return [Array] # # @!attribute [rw] dns_name # The DNS name of your Lightsail load balancer. # @return [String] # # @!attribute [rw] state # The status of your load balancer. Valid values are below. # @return [String] # # @!attribute [rw] protocol # The protocol you have enabled for your load balancer. Valid values # are below. # # You can't just have `HTTP_HTTPS`, but you can have just `HTTP`. # @return [String] # # @!attribute [rw] public_ports # An array of public port settings for your load balancer. For HTTP, # use port 80. For HTTPS, use port 443. # @return [Array] # # @!attribute [rw] health_check_path # The path you specified to perform your health checks. If no path is # specified, the load balancer tries to make a request to the default # (root) page. # @return [String] # # @!attribute [rw] instance_port # The port where the load balancer will direct traffic to your # Lightsail instances. For HTTP traffic, it's port 80. For HTTPS # traffic, it's port 443. # @return [Integer] # # @!attribute [rw] instance_health_summary # An array of InstanceHealthSummary objects describing the health of # the load balancer. # @return [Array] # # @!attribute [rw] tls_certificate_summaries # An array of LoadBalancerTlsCertificateSummary objects that provide # additional information about the SSL/TLS certificates. For example, # if `true`, the certificate is attached to the load balancer. # @return [Array] # # @!attribute [rw] configuration_options # A string to string map of the configuration options for your load # balancer. Valid values are listed below. # @return [Hash] # # @!attribute [rw] ip_address_type # The IP address type of the load balancer. # # The possible values are `ipv4` for IPv4 only, and `dualstack` for # IPv4 and IPv6. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/LoadBalancer AWS API Documentation # class LoadBalancer < Struct.new( :name, :arn, :support_code, :created_at, :location, :resource_type, :tags, :dns_name, :state, :protocol, :public_ports, :health_check_path, :instance_port, :instance_health_summary, :tls_certificate_summaries, :configuration_options, :ip_address_type) SENSITIVE = [] include Aws::Structure end # Describes a load balancer SSL/TLS certificate. # # TLS is just an updated, more secure version of Secure Socket Layer # (SSL). # # @!attribute [rw] name # The name of the SSL/TLS certificate (e.g., `my-certificate`). # @return [String] # # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the SSL/TLS certificate. # @return [String] # # @!attribute [rw] support_code # The support code. Include this code in your email to support when # you have questions about your Lightsail load balancer or SSL/TLS # certificate. This code enables our support team to look up your # Lightsail information more easily. # @return [String] # # @!attribute [rw] created_at # The time when you created your SSL/TLS certificate. # @return [Time] # # @!attribute [rw] location # The AWS Region and Availability Zone where you created your # certificate. # @return [Types::ResourceLocation] # # @!attribute [rw] resource_type # The resource type (e.g., `LoadBalancerTlsCertificate`). # # * Instance - A Lightsail instance (a virtual # private server) # # * StaticIp - A static IP address # # * KeyPair - The key pair used to connect to a # Lightsail instance # # * InstanceSnapshot - A Lightsail instance # snapshot # # * Domain - A DNS zone # # * PeeredVpc - A peered VPC # # * LoadBalancer - A Lightsail load balancer # # * LoadBalancerTlsCertificate - An SSL/TLS # certificate associated with a Lightsail load balancer # # * Disk - A Lightsail block storage disk # # * DiskSnapshot - A block storage disk snapshot # @return [String] # # @!attribute [rw] tags # The tag keys and optional values for the resource. For more # information about tags in Lightsail, see the [Amazon Lightsail # Developer Guide][1]. # # # # [1]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags # @return [Array] # # @!attribute [rw] load_balancer_name # The load balancer name where your SSL/TLS certificate is attached. # @return [String] # # @!attribute [rw] is_attached # When `true`, the SSL/TLS certificate is attached to the Lightsail # load balancer. # @return [Boolean] # # @!attribute [rw] status # The validation status of the SSL/TLS certificate. Valid values are # below. # @return [String] # # @!attribute [rw] domain_name # The domain name for your SSL/TLS certificate. # @return [String] # # @!attribute [rw] domain_validation_records # An array of LoadBalancerTlsCertificateDomainValidationRecord objects # describing the records. # @return [Array] # # @!attribute [rw] failure_reason # The validation failure reason, if any, of the certificate. # # The following failure reasons are possible: # # * NO_AVAILABLE_CONTACTS - This failure applies # to email validation, which is not available for Lightsail # certificates. # # * ADDITIONAL_VERIFICATION_REQUIRED - Lightsail # requires additional information to process this certificate # request. This can happen as a fraud-protection measure, such as # when the domain ranks within the Alexa top 1000 websites. To # provide the required information, use the [AWS Support Center][1] # to contact AWS Support. # # You cannot request a certificate for Amazon-owned domain names # such as those ending in amazonaws.com, cloudfront.net, or # elasticbeanstalk.com. # # # # * DOMAIN_NOT_ALLOWED - One or more of the # domain names in the certificate request was reported as an unsafe # domain by [VirusTotal][2]. To correct the problem, search for your # domain name on the [VirusTotal][2] website. If your domain is # reported as suspicious, see [Google Help for Hacked Websites][3] # to learn what you can do. # # If you believe that the result is a false positive, notify the # organization that is reporting the domain. VirusTotal is an # aggregate of several antivirus and URL scanners and cannot remove # your domain from a block list itself. After you correct the # problem and the VirusTotal registry has been updated, request a # new certificate. # # If you see this error and your domain is not included in the # VirusTotal list, visit the [AWS Support Center][1] and create a # case. # # * INVALID_PUBLIC_DOMAIN - One or more of the # domain names in the certificate request is not valid. Typically, # this is because a domain name in the request is not a valid # top-level domain. Try to request a certificate again, correcting # any spelling errors or typos that were in the failed request, and # ensure that all domain names in the request are for valid # top-level domains. For example, you cannot request a certificate # for `example.invalidpublicdomain` because `invalidpublicdomain` is # not a valid top-level domain. # # * OTHER - Typically, this failure occurs when # there is a typographical error in one or more of the domain names # in the certificate request. Try to request a certificate again, # correcting any spelling errors or typos that were in the failed # request. # # # # [1]: https://console.aws.amazon.com/support/home # [2]: https://www.virustotal.com/gui/home/url # [3]: https://developers.google.com/web/fundamentals/security/hacked # @return [String] # # @!attribute [rw] issued_at # The time when the SSL/TLS certificate was issued. # @return [Time] # # @!attribute [rw] issuer # The issuer of the certificate. # @return [String] # # @!attribute [rw] key_algorithm # The algorithm used to generate the key pair (the public and private # key). # @return [String] # # @!attribute [rw] not_after # The timestamp when the SSL/TLS certificate expires. # @return [Time] # # @!attribute [rw] not_before # The timestamp when the SSL/TLS certificate is first valid. # @return [Time] # # @!attribute [rw] renewal_summary # An object that describes the status of the certificate renewal # managed by Lightsail. # @return [Types::LoadBalancerTlsCertificateRenewalSummary] # # @!attribute [rw] revocation_reason # The reason the certificate was revoked. This value is present only # when the certificate status is `REVOKED`. # @return [String] # # @!attribute [rw] revoked_at # The timestamp when the certificate was revoked. This value is # present only when the certificate status is `REVOKED`. # @return [Time] # # @!attribute [rw] serial # The serial number of the certificate. # @return [String] # # @!attribute [rw] signature_algorithm # The algorithm that was used to sign the certificate. # @return [String] # # @!attribute [rw] subject # The name of the entity that is associated with the public key # contained in the certificate. # @return [String] # # @!attribute [rw] subject_alternative_names # An array of strings that specify the alternate domains (e.g., # `example2.com`) and subdomains (e.g., `blog.example.com`) for the # certificate. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/LoadBalancerTlsCertificate AWS API Documentation # class LoadBalancerTlsCertificate < Struct.new( :name, :arn, :support_code, :created_at, :location, :resource_type, :tags, :load_balancer_name, :is_attached, :status, :domain_name, :domain_validation_records, :failure_reason, :issued_at, :issuer, :key_algorithm, :not_after, :not_before, :renewal_summary, :revocation_reason, :revoked_at, :serial, :signature_algorithm, :subject, :subject_alternative_names) SENSITIVE = [] include Aws::Structure end # Contains information about the domain names on an SSL/TLS certificate # that you will use to validate domain ownership. # # @!attribute [rw] domain_name # The fully qualified domain name in the certificate request. # @return [String] # # @!attribute [rw] validation_status # The status of the domain validation. Valid values are listed below. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/LoadBalancerTlsCertificateDomainValidationOption AWS API Documentation # class LoadBalancerTlsCertificateDomainValidationOption < Struct.new( :domain_name, :validation_status) SENSITIVE = [] include Aws::Structure end # Describes the validation record of each domain name in the SSL/TLS # certificate. # # @!attribute [rw] name # A fully qualified domain name in the certificate. For example, # `example.com`. # @return [String] # # @!attribute [rw] type # The type of validation record. For example, `CNAME` for domain # validation. # @return [String] # # @!attribute [rw] value # The value for that type. # @return [String] # # @!attribute [rw] validation_status # The validation status. Valid values are listed below. # @return [String] # # @!attribute [rw] domain_name # The domain name against which your SSL/TLS certificate was # validated. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/LoadBalancerTlsCertificateDomainValidationRecord AWS API Documentation # class LoadBalancerTlsCertificateDomainValidationRecord < Struct.new( :name, :type, :value, :validation_status, :domain_name) SENSITIVE = [] include Aws::Structure end # Contains information about the status of Lightsail's managed renewal # for the certificate. # # The renewal status of the certificate. # # The following renewal status are possible: # # * PendingAutoRenewal - Lightsail is attempting # to automatically validate the domain names in the certificate. No # further action is required. # # * PendingValidation - Lightsail couldn't # automatically validate one or more domain names in the certificate. # You must take action to validate these domain names or the # certificate won't be renewed. If you used DNS validation, check to # make sure your certificate's domain validation records exist in # your domain's DNS, and that your certificate remains in use. # # * Success - All domain names in the certificate # are validated, and Lightsail renewed the certificate. No further # action is required. # # * Failed - One or more domain names were not # validated before the certificate expired, and Lightsail did not # renew the certificate. You can request a new certificate using the # `CreateCertificate` action. # # @!attribute [rw] renewal_status # The renewal status of the certificate. # # The following renewal status are possible: # # * PendingAutoRenewal - Lightsail is attempting # to automatically validate the domain names of the certificate. No # further action is required. # # * PendingValidation - Lightsail couldn't # automatically validate one or more domain names of the # certificate. You must take action to validate these domain names # or the certificate won't be renewed. Check to make sure your # certificate's domain validation records exist in your domain's # DNS, and that your certificate remains in use. # # * Success - All domain names in the # certificate are validated, and Lightsail renewed the certificate. # No further action is required. # # * Failed - One or more domain names were not # validated before the certificate expired, and Lightsail did not # renew the certificate. You can request a new certificate using the # `CreateCertificate` action. # @return [String] # # @!attribute [rw] domain_validation_options # Contains information about the validation of each domain name in the # certificate, as it pertains to Lightsail's managed renewal. This is # different from the initial validation that occurs as a result of the # RequestCertificate request. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/LoadBalancerTlsCertificateRenewalSummary AWS API Documentation # class LoadBalancerTlsCertificateRenewalSummary < Struct.new( :renewal_status, :domain_validation_options) SENSITIVE = [] include Aws::Structure end # Provides a summary of SSL/TLS certificate metadata. # # @!attribute [rw] name # The name of the SSL/TLS certificate. # @return [String] # # @!attribute [rw] is_attached # When `true`, the SSL/TLS certificate is attached to the Lightsail # load balancer. # @return [Boolean] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/LoadBalancerTlsCertificateSummary AWS API Documentation # class LoadBalancerTlsCertificateSummary < Struct.new( :name, :is_attached) SENSITIVE = [] include Aws::Structure end # Describes a database log event. # # @!attribute [rw] created_at # The timestamp when the database log event was created. # @return [Time] # # @!attribute [rw] message # The message of the database log event. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/LogEvent AWS API Documentation # class LogEvent < Struct.new( :created_at, :message) SENSITIVE = [] include Aws::Structure end # Describes the metric data point. # # @!attribute [rw] average # The average. # @return [Float] # # @!attribute [rw] maximum # The maximum. # @return [Float] # # @!attribute [rw] minimum # The minimum. # @return [Float] # # @!attribute [rw] sample_count # The sample count. # @return [Float] # # @!attribute [rw] sum # The sum. # @return [Float] # # @!attribute [rw] timestamp # The timestamp (e.g., `1479816991.349`). # @return [Time] # # @!attribute [rw] unit # The unit. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/MetricDatapoint AWS API Documentation # class MetricDatapoint < Struct.new( :average, :maximum, :minimum, :sample_count, :sum, :timestamp, :unit) SENSITIVE = [] include Aws::Structure end # Describes resource being monitored by an alarm. # # An alarm is a way to monitor your Amazon Lightsail resource metrics. # For more information, see [Alarms in Amazon Lightsail][1]. # # # # [1]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-alarms # # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the resource being monitored. # @return [String] # # @!attribute [rw] name # The name of the Lightsail resource being monitored. # @return [String] # # @!attribute [rw] resource_type # The Lightsail resource type of the resource being monitored. # # Instances, load balancers, and relational databases are the only # Lightsail resources that can currently be monitored by alarms. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/MonitoredResourceInfo AWS API Documentation # class MonitoredResourceInfo < Struct.new( :arn, :name, :resource_type) SENSITIVE = [] include Aws::Structure end # Describes the monthly data transfer in and out of your virtual private # server (or *instance*). # # @!attribute [rw] gb_per_month_allocated # The amount allocated per month (in GB). # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/MonthlyTransfer AWS API Documentation # class MonthlyTransfer < Struct.new( :gb_per_month_allocated) SENSITIVE = [] include Aws::Structure end # Lightsail throws this exception when it cannot find a resource. # # @!attribute [rw] code # @return [String] # # @!attribute [rw] docs # @return [String] # # @!attribute [rw] message # @return [String] # # @!attribute [rw] tip # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/NotFoundException AWS API Documentation # class NotFoundException < Struct.new( :code, :docs, :message, :tip) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass OpenInstancePublicPortsRequest # data as a hash: # # { # port_info: { # required # from_port: 1, # to_port: 1, # protocol: "tcp", # accepts tcp, all, udp, icmp # cidrs: ["string"], # ipv6_cidrs: ["string"], # cidr_list_aliases: ["string"], # }, # instance_name: "ResourceName", # required # } # # @!attribute [rw] port_info # An object to describe the ports to open for the specified instance. # @return [Types::PortInfo] # # @!attribute [rw] instance_name # The name of the instance for which to open ports. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/OpenInstancePublicPortsRequest AWS API Documentation # class OpenInstancePublicPortsRequest < Struct.new( :port_info, :instance_name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] operation # An array of objects that describe the result of the action, such as # the status of the request, the timestamp of the request, and the # resources affected by the request. # @return [Types::Operation] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/OpenInstancePublicPortsResult AWS API Documentation # class OpenInstancePublicPortsResult < Struct.new( :operation) SENSITIVE = [] include Aws::Structure end # Describes the API operation. # # @!attribute [rw] id # The ID of the operation. # @return [String] # # @!attribute [rw] resource_name # The resource name. # @return [String] # # @!attribute [rw] resource_type # The resource type. # @return [String] # # @!attribute [rw] created_at # The timestamp when the operation was initialized (e.g., # `1479816991.349`). # @return [Time] # # @!attribute [rw] location # The AWS Region and Availability Zone. # @return [Types::ResourceLocation] # # @!attribute [rw] is_terminal # A Boolean value indicating whether the operation is terminal. # @return [Boolean] # # @!attribute [rw] operation_details # Details about the operation (e.g., `Debian-1GB-Ohio-1`). # @return [String] # # @!attribute [rw] operation_type # The type of operation. # @return [String] # # @!attribute [rw] status # The status of the operation. # @return [String] # # @!attribute [rw] status_changed_at # The timestamp when the status was changed (e.g., `1479816991.349`). # @return [Time] # # @!attribute [rw] error_code # The error code. # @return [String] # # @!attribute [rw] error_details # The error details. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/Operation AWS API Documentation # class Operation < Struct.new( :id, :resource_name, :resource_type, :created_at, :location, :is_terminal, :operation_details, :operation_type, :status, :status_changed_at, :error_code, :error_details) SENSITIVE = [] include Aws::Structure end # Lightsail throws this exception when an operation fails to execute. # # @!attribute [rw] code # @return [String] # # @!attribute [rw] docs # @return [String] # # @!attribute [rw] message # @return [String] # # @!attribute [rw] tip # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/OperationFailureException AWS API Documentation # class OperationFailureException < Struct.new( :code, :docs, :message, :tip) SENSITIVE = [] include Aws::Structure end # Describes the origin resource of an Amazon Lightsail content delivery # network (CDN) distribution. # # An origin can be a Lightsail instance or load balancer. A distribution # pulls content from an origin, caches it, and serves it to viewers via # a worldwide network of edge servers. # # @!attribute [rw] name # The name of the origin resource. # @return [String] # # @!attribute [rw] resource_type # The resource type of the origin resource (e.g., *Instance*). # @return [String] # # @!attribute [rw] region_name # The AWS Region name of the origin resource. # @return [String] # # @!attribute [rw] protocol_policy # The protocol that your Amazon Lightsail distribution uses when # establishing a connection with your origin to pull content. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/Origin AWS API Documentation # class Origin < Struct.new( :name, :resource_type, :region_name, :protocol_policy) SENSITIVE = [] include Aws::Structure end # The password data for the Windows Server-based instance, including the # ciphertext and the key pair name. # # @!attribute [rw] ciphertext # The encrypted password. Ciphertext will be an empty string if access # to your new instance is not ready yet. When you create an instance, # it can take up to 15 minutes for the instance to be ready. # # If you use the default key pair (`LightsailDefaultKeyPair`), the # decrypted password will be available in the password field. # # If you are using a custom key pair, you need to use your own means # of decryption. # # If you change the Administrator password on the instance, Lightsail # will continue to return the original ciphertext value. When # accessing the instance using RDP, you need to manually enter the # Administrator password after changing it from the default. # # # @return [String] # # @!attribute [rw] key_pair_name # The name of the key pair that you used when creating your instance. # If no key pair name was specified when creating the instance, # Lightsail uses the default key pair (`LightsailDefaultKeyPair`). # # If you are using a custom key pair, you need to use your own means # of decrypting your password using the `ciphertext`. Lightsail # creates the ciphertext by encrypting your password with the public # key part of this key pair. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/PasswordData AWS API Documentation # class PasswordData < Struct.new( :ciphertext, :key_pair_name) SENSITIVE = [] include Aws::Structure end # @api private # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/PeerVpcRequest AWS API Documentation # class PeerVpcRequest < Aws::EmptyStructure; end # @!attribute [rw] operation # An array of objects that describe the result of the action, such as # the status of the request, the timestamp of the request, and the # resources affected by the request. # @return [Types::Operation] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/PeerVpcResult AWS API Documentation # class PeerVpcResult < Struct.new( :operation) SENSITIVE = [] include Aws::Structure end # Describes a pending database maintenance action. # # @!attribute [rw] action # The type of pending database maintenance action. # @return [String] # # @!attribute [rw] description # Additional detail about the pending database maintenance action. # @return [String] # # @!attribute [rw] current_apply_date # The effective date of the pending database maintenance action. # @return [Time] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/PendingMaintenanceAction AWS API Documentation # class PendingMaintenanceAction < Struct.new( :action, :description, :current_apply_date) SENSITIVE = [] include Aws::Structure end # Describes a pending database value modification. # # @!attribute [rw] master_user_password # The password for the master user of the database. # @return [String] # # @!attribute [rw] engine_version # The database engine version. # @return [String] # # @!attribute [rw] backup_retention_enabled # A Boolean value indicating whether automated backup retention is # enabled. # @return [Boolean] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/PendingModifiedRelationalDatabaseValues AWS API Documentation # class PendingModifiedRelationalDatabaseValues < Struct.new( :master_user_password, :engine_version, :backup_retention_enabled) SENSITIVE = [] include Aws::Structure end # Describes ports to open on an instance, the IP addresses allowed to # connect to the instance through the ports, and the protocol. # # @note When making an API call, you may pass PortInfo # data as a hash: # # { # from_port: 1, # to_port: 1, # protocol: "tcp", # accepts tcp, all, udp, icmp # cidrs: ["string"], # ipv6_cidrs: ["string"], # cidr_list_aliases: ["string"], # } # # @!attribute [rw] from_port # The first port in a range of open ports on an instance. # # Allowed ports: # # * TCP and UDP - `0` to `65535` # # * ICMP - The ICMP type for IPv4 addresses. For example, specify `8` # as the `fromPort` (ICMP type), and `-1` as the `toPort` (ICMP # code), to enable ICMP Ping. For more information, see [Control # Messages][1] on *Wikipedia*. # # * ICMPv6 - The ICMP type for IPv6 addresses. For example, specify # `128` as the `fromPort` (ICMPv6 type), and `0` as `toPort` (ICMPv6 # code). For more information, see [Internet Control Message # Protocol for IPv6][2]. # # # # [1]: https://en.wikipedia.org/wiki/Internet_Control_Message_Protocol#Control_messages # [2]: https://en.wikipedia.org/wiki/Internet_Control_Message_Protocol_for_IPv6 # @return [Integer] # # @!attribute [rw] to_port # The last port in a range of open ports on an instance. # # Allowed ports: # # * TCP and UDP - `0` to `65535` # # * ICMP - The ICMP code for IPv4 addresses. For example, specify `8` # as the `fromPort` (ICMP type), and `-1` as the `toPort` (ICMP # code), to enable ICMP Ping. For more information, see [Control # Messages][1] on *Wikipedia*. # # * ICMPv6 - The ICMP code for IPv6 addresses. For example, specify # `128` as the `fromPort` (ICMPv6 type), and `0` as `toPort` (ICMPv6 # code). For more information, see [Internet Control Message # Protocol for IPv6][2]. # # # # [1]: https://en.wikipedia.org/wiki/Internet_Control_Message_Protocol#Control_messages # [2]: https://en.wikipedia.org/wiki/Internet_Control_Message_Protocol_for_IPv6 # @return [Integer] # # @!attribute [rw] protocol # The IP protocol name. # # The name can be one of the following: # # * `tcp` - Transmission Control Protocol (TCP) provides reliable, # ordered, and error-checked delivery of streamed data between # applications running on hosts communicating by an IP network. If # you have an application that doesn't require reliable data stream # service, use UDP instead. # # * `all` - All transport layer protocol types. For more general # information, see [Transport layer][1] on *Wikipedia*. # # * `udp` - With User Datagram Protocol (UDP), computer applications # can send messages (or datagrams) to other hosts on an Internet # Protocol (IP) network. Prior communications are not required to # set up transmission channels or data paths. Applications that # don't require reliable data stream service can use UDP, which # provides a connectionless datagram service that emphasizes reduced # latency over reliability. If you do require reliable data stream # service, use TCP instead. # # * `icmp` - Internet Control Message Protocol (ICMP) is used to send # error messages and operational information indicating success or # failure when communicating with an instance. For example, an error # is indicated when an instance could not be reached. When you # specify `icmp` as the `protocol`, you must specify the ICMP type # using the `fromPort` parameter, and ICMP code using the `toPort` # parameter. # # # # [1]: https://en.wikipedia.org/wiki/Transport_layer # @return [String] # # @!attribute [rw] cidrs # The IPv4 address, or range of IPv4 addresses (in CIDR notation) that # are allowed to connect to an instance through the ports, and the # protocol. # # The `ipv6Cidrs` parameter lists the IPv6 addresses that are allowed # to connect to an instance. # # # # Examples: # # * To allow the IP address `192.0.2.44`, specify `192.0.2.44` or # `192.0.2.44/32`. # # * To allow the IP addresses `192.0.2.0` to `192.0.2.255`, specify # `192.0.2.0/24`. # # For more information about CIDR block notation, see [Classless # Inter-Domain Routing][1] on *Wikipedia*. # # # # [1]: https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing#CIDR_notation # @return [Array] # # @!attribute [rw] ipv6_cidrs # The IPv6 address, or range of IPv6 addresses (in CIDR notation) that # are allowed to connect to an instance through the ports, and the # protocol. Only devices with an IPv6 address can connect to an # instance through IPv6; otherwise, IPv4 should be used. # # The `cidrs` parameter lists the IPv4 addresses that are allowed to # connect to an instance. # # # # For more information about CIDR block notation, see [Classless # Inter-Domain Routing][1] on *Wikipedia*. # # # # [1]: https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing#CIDR_notation # @return [Array] # # @!attribute [rw] cidr_list_aliases # An alias that defines access for a preconfigured range of IP # addresses. # # The only alias currently supported is `lightsail-connect`, which # allows IP addresses of the browser-based RDP/SSH client in the # Lightsail console to connect to your instance. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/PortInfo AWS API Documentation # class PortInfo < Struct.new( :from_port, :to_port, :protocol, :cidrs, :ipv6_cidrs, :cidr_list_aliases) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass PutAlarmRequest # data as a hash: # # { # alarm_name: "ResourceName", # required # metric_name: "CPUUtilization", # required, accepts CPUUtilization, NetworkIn, NetworkOut, StatusCheckFailed, StatusCheckFailed_Instance, StatusCheckFailed_System, ClientTLSNegotiationErrorCount, HealthyHostCount, UnhealthyHostCount, HTTPCode_LB_4XX_Count, HTTPCode_LB_5XX_Count, HTTPCode_Instance_2XX_Count, HTTPCode_Instance_3XX_Count, HTTPCode_Instance_4XX_Count, HTTPCode_Instance_5XX_Count, InstanceResponseTime, RejectedConnectionCount, RequestCount, DatabaseConnections, DiskQueueDepth, FreeStorageSpace, NetworkReceiveThroughput, NetworkTransmitThroughput, BurstCapacityTime, BurstCapacityPercentage # monitored_resource_name: "ResourceName", # required # comparison_operator: "GreaterThanOrEqualToThreshold", # required, accepts GreaterThanOrEqualToThreshold, GreaterThanThreshold, LessThanThreshold, LessThanOrEqualToThreshold # threshold: 1.0, # required # evaluation_periods: 1, # required # datapoints_to_alarm: 1, # treat_missing_data: "breaching", # accepts breaching, notBreaching, ignore, missing # contact_protocols: ["Email"], # accepts Email, SMS # notification_triggers: ["OK"], # accepts OK, ALARM, INSUFFICIENT_DATA # notification_enabled: false, # } # # @!attribute [rw] alarm_name # The name for the alarm. Specify the name of an existing alarm to # update, and overwrite the previous configuration of the alarm. # @return [String] # # @!attribute [rw] metric_name # The name of the metric to associate with the alarm. # # You can configure up to two alarms per metric. # # The following metrics are available for each resource type: # # * **Instances**\: `BurstCapacityPercentage`, `BurstCapacityTime`, # `CPUUtilization`, `NetworkIn`, `NetworkOut`, `StatusCheckFailed`, # `StatusCheckFailed_Instance`, and `StatusCheckFailed_System`. # # * **Load balancers**\: `ClientTLSNegotiationErrorCount`, # `HealthyHostCount`, `UnhealthyHostCount`, `HTTPCode_LB_4XX_Count`, # `HTTPCode_LB_5XX_Count`, `HTTPCode_Instance_2XX_Count`, # `HTTPCode_Instance_3XX_Count`, `HTTPCode_Instance_4XX_Count`, # `HTTPCode_Instance_5XX_Count`, `InstanceResponseTime`, # `RejectedConnectionCount`, and `RequestCount`. # # * **Relational databases**\: `CPUUtilization`, # `DatabaseConnections`, `DiskQueueDepth`, `FreeStorageSpace`, # `NetworkReceiveThroughput`, and `NetworkTransmitThroughput`. # # For more information about these metrics, see [Metrics available in # Lightsail][1]. # # # # [1]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-resource-health-metrics#available-metrics # @return [String] # # @!attribute [rw] monitored_resource_name # The name of the Lightsail resource that will be monitored. # # Instances, load balancers, and relational databases are the only # Lightsail resources that can currently be monitored by alarms. # @return [String] # # @!attribute [rw] comparison_operator # The arithmetic operation to use when comparing the specified # statistic to the threshold. The specified statistic value is used as # the first operand. # @return [String] # # @!attribute [rw] threshold # The value against which the specified statistic is compared. # @return [Float] # # @!attribute [rw] evaluation_periods # The number of most recent periods over which data is compared to the # specified threshold. If you are setting an "M out of N" alarm, # this value (`evaluationPeriods`) is the N. # # If you are setting an alarm that requires that a number of # consecutive data points be breaching to trigger the alarm, this # value specifies the rolling period of time in which data points are # evaluated. # # Each evaluation period is five minutes long. For example, specify an # evaluation period of 24 to evaluate a metric over a rolling period # of two hours. # # You can specify a minimum valuation period of 1 (5 minutes), and a # maximum evaluation period of 288 (24 hours). # @return [Integer] # # @!attribute [rw] datapoints_to_alarm # The number of data points that must be not within the specified # threshold to trigger the alarm. If you are setting an "M out of N" # alarm, this value (`datapointsToAlarm`) is the M. # @return [Integer] # # @!attribute [rw] treat_missing_data # Sets how this alarm will handle missing data points. # # An alarm can treat missing data in the following ways: # # * `breaching` - Assume the missing data is not within the threshold. # Missing data counts towards the number of times the metric is not # within the threshold. # # * `notBreaching` - Assume the missing data is within the threshold. # Missing data does not count towards the number of times the metric # is not within the threshold. # # * `ignore` - Ignore the missing data. Maintains the current alarm # state. # # * `missing` - Missing data is treated as missing. # # If `treatMissingData` is not specified, the default behavior of # `missing` is used. # @return [String] # # @!attribute [rw] contact_protocols # The contact protocols to use for the alarm, such as `Email`, `SMS` # (text messaging), or both. # # A notification is sent via the specified contact protocol if # notifications are enabled for the alarm, and when the alarm is # triggered. # # A notification is not sent if a contact protocol is not specified, # if the specified contact protocol is not configured in the AWS # Region, or if notifications are not enabled for the alarm using the # `notificationEnabled` paramater. # # Use the `CreateContactMethod` action to configure a contact protocol # in an AWS Region. # @return [Array] # # @!attribute [rw] notification_triggers # The alarm states that trigger a notification. # # An alarm has the following possible states: # # * `ALARM` - The metric is outside of the defined threshold. # # * `INSUFFICIENT_DATA` - The alarm has just started, the metric is # not available, or not enough data is available for the metric to # determine the alarm state. # # * `OK` - The metric is within the defined threshold. # # When you specify a notification trigger, the `ALARM` state must be # specified. The `INSUFFICIENT_DATA` and `OK` states can be specified # in addition to the `ALARM` state. # # * If you specify `OK` as an alarm trigger, a notification is sent # when the alarm switches from an `ALARM` or `INSUFFICIENT_DATA` # alarm state to an `OK` state. This can be thought of as an *all # clear* alarm notification. # # * If you specify `INSUFFICIENT_DATA` as the alarm trigger, a # notification is sent when the alarm switches from an `OK` or # `ALARM` alarm state to an `INSUFFICIENT_DATA` state. # # The notification trigger defaults to `ALARM` if you don't specify # this parameter. # @return [Array] # # @!attribute [rw] notification_enabled # Indicates whether the alarm is enabled. # # Notifications are enabled by default if you don't specify this # parameter. # @return [Boolean] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/PutAlarmRequest AWS API Documentation # class PutAlarmRequest < Struct.new( :alarm_name, :metric_name, :monitored_resource_name, :comparison_operator, :threshold, :evaluation_periods, :datapoints_to_alarm, :treat_missing_data, :contact_protocols, :notification_triggers, :notification_enabled) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] operations # An array of objects that describe the result of the action, such as # the status of the request, the timestamp of the request, and the # resources affected by the request. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/PutAlarmResult AWS API Documentation # class PutAlarmResult < Struct.new( :operations) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass PutInstancePublicPortsRequest # data as a hash: # # { # port_infos: [ # required # { # from_port: 1, # to_port: 1, # protocol: "tcp", # accepts tcp, all, udp, icmp # cidrs: ["string"], # ipv6_cidrs: ["string"], # cidr_list_aliases: ["string"], # }, # ], # instance_name: "ResourceName", # required # } # # @!attribute [rw] port_infos # An array of objects to describe the ports to open for the specified # instance. # @return [Array] # # @!attribute [rw] instance_name # The name of the instance for which to open ports. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/PutInstancePublicPortsRequest AWS API Documentation # class PutInstancePublicPortsRequest < Struct.new( :port_infos, :instance_name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] operation # An array of objects that describe the result of the action, such as # the status of the request, the timestamp of the request, and the # resources affected by the request. # @return [Types::Operation] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/PutInstancePublicPortsResult AWS API Documentation # class PutInstancePublicPortsResult < Struct.new( :operation) SENSITIVE = [] include Aws::Structure end # Describes the query string parameters that an Amazon Lightsail content # delivery network (CDN) distribution to bases caching on. # # For the query strings that you specify, your distribution caches # separate versions of the specified content based on the query string # values in viewer requests. # # @note When making an API call, you may pass QueryStringObject # data as a hash: # # { # option: false, # query_strings_allow_list: ["string"], # } # # @!attribute [rw] option # Indicates whether the distribution forwards and caches based on # query strings. # @return [Boolean] # # @!attribute [rw] query_strings_allow_list # The specific query strings that the distribution forwards to the # origin. # # Your distribution will cache content based on the specified query # strings. # # If the `option` parameter is true, then your distribution forwards # all query strings, regardless of what you specify using the # `queryStringsAllowList` parameter. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/QueryStringObject AWS API Documentation # class QueryStringObject < Struct.new( :option, :query_strings_allow_list) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass RebootInstanceRequest # data as a hash: # # { # instance_name: "ResourceName", # required # } # # @!attribute [rw] instance_name # The name of the instance to reboot. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/RebootInstanceRequest AWS API Documentation # class RebootInstanceRequest < Struct.new( :instance_name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] operations # An array of objects that describe the result of the action, such as # the status of the request, the timestamp of the request, and the # resources affected by the request. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/RebootInstanceResult AWS API Documentation # class RebootInstanceResult < Struct.new( :operations) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass RebootRelationalDatabaseRequest # data as a hash: # # { # relational_database_name: "ResourceName", # required # } # # @!attribute [rw] relational_database_name # The name of your database to reboot. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/RebootRelationalDatabaseRequest AWS API Documentation # class RebootRelationalDatabaseRequest < Struct.new( :relational_database_name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] operations # An array of objects that describe the result of the action, such as # the status of the request, the timestamp of the request, and the # resources affected by the request. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/RebootRelationalDatabaseResult AWS API Documentation # class RebootRelationalDatabaseResult < Struct.new( :operations) SENSITIVE = [] include Aws::Structure end # Describes the AWS Region. # # @!attribute [rw] continent_code # The continent code (e.g., `NA`, meaning North America). # @return [String] # # @!attribute [rw] description # The description of the AWS Region (e.g., `This region is recommended # to serve users in the eastern United States and eastern Canada`). # @return [String] # # @!attribute [rw] display_name # The display name (e.g., `Ohio`). # @return [String] # # @!attribute [rw] name # The region name (e.g., `us-east-2`). # @return [String] # # @!attribute [rw] availability_zones # The Availability Zones. Follows the format `us-east-2a` # (case-sensitive). # @return [Array] # # @!attribute [rw] relational_database_availability_zones # The Availability Zones for databases. Follows the format # `us-east-2a` (case-sensitive). # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/Region AWS API Documentation # class Region < Struct.new( :continent_code, :description, :display_name, :name, :availability_zones, :relational_database_availability_zones) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass RegisterContainerImageRequest # data as a hash: # # { # service_name: "ContainerServiceName", # required # label: "ContainerLabel", # required # digest: "string", # required # } # # @!attribute [rw] service_name # The name of the container service for which to register a container # image. # @return [String] # # @!attribute [rw] label # The label for the container image when it's registered to the # container service. # # Use a descriptive label that you can use to track the different # versions of your registered container images. # # Use the `GetContainerImages` action to return the container images # registered to a Lightsail container service. The label is the # `` portion of the following image name example: # # * `:container-service-1..1` # # ^ # # If the name of your container service is `mycontainerservice`, and # the label that you specify is `mystaticwebsite`, then the name of # the registered container image will be # `:mycontainerservice.mystaticwebsite.1`. # # The number at the end of these image name examples represents the # version of the registered container image. If you push and register # another container image to the same Lightsail container service, # with the same label, then the version number for the new registered # container image will be `2`. If you push and register another # container image, the version number will be `3`, and so on. # @return [String] # # @!attribute [rw] digest # The digest of the container image to be registered. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/RegisterContainerImageRequest AWS API Documentation # class RegisterContainerImageRequest < Struct.new( :service_name, :label, :digest) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] container_image # Describes a container image that is registered to an Amazon # Lightsail container service. # @return [Types::ContainerImage] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/RegisterContainerImageResult AWS API Documentation # class RegisterContainerImageResult < Struct.new( :container_image) SENSITIVE = [] include Aws::Structure end # Describes a database. # # @!attribute [rw] name # The unique name of the database resource in Lightsail. # @return [String] # # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the database. # @return [String] # # @!attribute [rw] support_code # The support code for the database. Include this code in your email # to support when you have questions about a database in Lightsail. # This code enables our support team to look up your Lightsail # information more easily. # @return [String] # # @!attribute [rw] created_at # The timestamp when the database was created. Formatted in Unix time. # @return [Time] # # @!attribute [rw] location # The Region name and Availability Zone where the database is located. # @return [Types::ResourceLocation] # # @!attribute [rw] resource_type # The Lightsail resource type for the database (for example, # `RelationalDatabase`). # @return [String] # # @!attribute [rw] tags # The tag keys and optional values for the resource. For more # information about tags in Lightsail, see the [Amazon Lightsail # Developer Guide][1]. # # # # [1]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags # @return [Array] # # @!attribute [rw] relational_database_blueprint_id # The blueprint ID for the database. A blueprint describes the major # engine version of a database. # @return [String] # # @!attribute [rw] relational_database_bundle_id # The bundle ID for the database. A bundle describes the performance # specifications for your database. # @return [String] # # @!attribute [rw] master_database_name # The name of the master database created when the Lightsail database # resource is created. # @return [String] # # @!attribute [rw] hardware # Describes the hardware of the database. # @return [Types::RelationalDatabaseHardware] # # @!attribute [rw] state # Describes the current state of the database. # @return [String] # # @!attribute [rw] secondary_availability_zone # Describes the secondary Availability Zone of a high availability # database. # # The secondary database is used for failover support of a high # availability database. # @return [String] # # @!attribute [rw] backup_retention_enabled # A Boolean value indicating whether automated backup retention is # enabled for the database. # @return [Boolean] # # @!attribute [rw] pending_modified_values # Describes pending database value modifications. # @return [Types::PendingModifiedRelationalDatabaseValues] # # @!attribute [rw] engine # The database software (for example, `MySQL`). # @return [String] # # @!attribute [rw] engine_version # The database engine version (for example, `5.7.23`). # @return [String] # # @!attribute [rw] latest_restorable_time # The latest point in time to which the database can be restored. # Formatted in Unix time. # @return [Time] # # @!attribute [rw] master_username # The master user name of the database. # @return [String] # # @!attribute [rw] parameter_apply_status # The status of parameter updates for the database. # @return [String] # # @!attribute [rw] preferred_backup_window # The daily time range during which automated backups are created for # the database (for example, `16:00-16:30`). # @return [String] # # @!attribute [rw] preferred_maintenance_window # The weekly time range during which system maintenance can occur on # the database. # # In the format `ddd:hh24:mi-ddd:hh24:mi`. For example, # `Tue:17:00-Tue:17:30`. # @return [String] # # @!attribute [rw] publicly_accessible # A Boolean value indicating whether the database is publicly # accessible. # @return [Boolean] # # @!attribute [rw] master_endpoint # The master endpoint for the database. # @return [Types::RelationalDatabaseEndpoint] # # @!attribute [rw] pending_maintenance_actions # Describes the pending maintenance actions for the database. # @return [Array] # # @!attribute [rw] ca_certificate_identifier # The certificate associated with the database. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/RelationalDatabase AWS API Documentation # class RelationalDatabase < Struct.new( :name, :arn, :support_code, :created_at, :location, :resource_type, :tags, :relational_database_blueprint_id, :relational_database_bundle_id, :master_database_name, :hardware, :state, :secondary_availability_zone, :backup_retention_enabled, :pending_modified_values, :engine, :engine_version, :latest_restorable_time, :master_username, :parameter_apply_status, :preferred_backup_window, :preferred_maintenance_window, :publicly_accessible, :master_endpoint, :pending_maintenance_actions, :ca_certificate_identifier) SENSITIVE = [] include Aws::Structure end # Describes a database image, or blueprint. A blueprint describes the # major engine version of a database. # # @!attribute [rw] blueprint_id # The ID for the database blueprint. # @return [String] # # @!attribute [rw] engine # The database software of the database blueprint (for example, # `MySQL`). # @return [String] # # @!attribute [rw] engine_version # The database engine version for the database blueprint (for example, # `5.7.23`). # @return [String] # # @!attribute [rw] engine_description # The description of the database engine for the database blueprint. # @return [String] # # @!attribute [rw] engine_version_description # The description of the database engine version for the database # blueprint. # @return [String] # # @!attribute [rw] is_engine_default # A Boolean value indicating whether the engine version is the default # for the database blueprint. # @return [Boolean] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/RelationalDatabaseBlueprint AWS API Documentation # class RelationalDatabaseBlueprint < Struct.new( :blueprint_id, :engine, :engine_version, :engine_description, :engine_version_description, :is_engine_default) SENSITIVE = [] include Aws::Structure end # Describes a database bundle. A bundle describes the performance # specifications of the database. # # @!attribute [rw] bundle_id # The ID for the database bundle. # @return [String] # # @!attribute [rw] name # The name for the database bundle. # @return [String] # # @!attribute [rw] price # The cost of the database bundle in US currency. # @return [Float] # # @!attribute [rw] ram_size_in_gb # The amount of RAM in GB (for example, `2.0`) for the database # bundle. # @return [Float] # # @!attribute [rw] disk_size_in_gb # The size of the disk for the database bundle. # @return [Integer] # # @!attribute [rw] transfer_per_month_in_gb # The data transfer rate per month in GB for the database bundle. # @return [Integer] # # @!attribute [rw] cpu_count # The number of virtual CPUs (vCPUs) for the database bundle. # @return [Integer] # # @!attribute [rw] is_encrypted # A Boolean value indicating whether the database bundle is encrypted. # @return [Boolean] # # @!attribute [rw] is_active # A Boolean value indicating whether the database bundle is active. # @return [Boolean] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/RelationalDatabaseBundle AWS API Documentation # class RelationalDatabaseBundle < Struct.new( :bundle_id, :name, :price, :ram_size_in_gb, :disk_size_in_gb, :transfer_per_month_in_gb, :cpu_count, :is_encrypted, :is_active) SENSITIVE = [] include Aws::Structure end # Describes an endpoint for a database. # # @!attribute [rw] port # Specifies the port that the database is listening on. # @return [Integer] # # @!attribute [rw] address # Specifies the DNS address of the database. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/RelationalDatabaseEndpoint AWS API Documentation # class RelationalDatabaseEndpoint < Struct.new( :port, :address) SENSITIVE = [] include Aws::Structure end # Describes an event for a database. # # @!attribute [rw] resource # The database that the database event relates to. # @return [String] # # @!attribute [rw] created_at # The timestamp when the database event was created. # @return [Time] # # @!attribute [rw] message # The message of the database event. # @return [String] # # @!attribute [rw] event_categories # The category that the database event belongs to. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/RelationalDatabaseEvent AWS API Documentation # class RelationalDatabaseEvent < Struct.new( :resource, :created_at, :message, :event_categories) SENSITIVE = [] include Aws::Structure end # Describes the hardware of a database. # # @!attribute [rw] cpu_count # The number of vCPUs for the database. # @return [Integer] # # @!attribute [rw] disk_size_in_gb # The size of the disk for the database. # @return [Integer] # # @!attribute [rw] ram_size_in_gb # The amount of RAM in GB for the database. # @return [Float] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/RelationalDatabaseHardware AWS API Documentation # class RelationalDatabaseHardware < Struct.new( :cpu_count, :disk_size_in_gb, :ram_size_in_gb) SENSITIVE = [] include Aws::Structure end # Describes the parameters of a database. # # @note When making an API call, you may pass RelationalDatabaseParameter # data as a hash: # # { # allowed_values: "string", # apply_method: "string", # apply_type: "string", # data_type: "string", # description: "string", # is_modifiable: false, # parameter_name: "string", # parameter_value: "string", # } # # @!attribute [rw] allowed_values # Specifies the valid range of values for the parameter. # @return [String] # # @!attribute [rw] apply_method # Indicates when parameter updates are applied. # # Can be `immediate` or `pending-reboot`. # @return [String] # # @!attribute [rw] apply_type # Specifies the engine-specific parameter type. # @return [String] # # @!attribute [rw] data_type # Specifies the valid data type for the parameter. # @return [String] # # @!attribute [rw] description # Provides a description of the parameter. # @return [String] # # @!attribute [rw] is_modifiable # A Boolean value indicating whether the parameter can be modified. # @return [Boolean] # # @!attribute [rw] parameter_name # Specifies the name of the parameter. # @return [String] # # @!attribute [rw] parameter_value # Specifies the value of the parameter. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/RelationalDatabaseParameter AWS API Documentation # class RelationalDatabaseParameter < Struct.new( :allowed_values, :apply_method, :apply_type, :data_type, :description, :is_modifiable, :parameter_name, :parameter_value) SENSITIVE = [] include Aws::Structure end # Describes a database snapshot. # # @!attribute [rw] name # The name of the database snapshot. # @return [String] # # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the database snapshot. # @return [String] # # @!attribute [rw] support_code # The support code for the database snapshot. Include this code in # your email to support when you have questions about a database # snapshot in Lightsail. This code enables our support team to look up # your Lightsail information more easily. # @return [String] # # @!attribute [rw] created_at # The timestamp when the database snapshot was created. # @return [Time] # # @!attribute [rw] location # The Region name and Availability Zone where the database snapshot is # located. # @return [Types::ResourceLocation] # # @!attribute [rw] resource_type # The Lightsail resource type. # @return [String] # # @!attribute [rw] tags # The tag keys and optional values for the resource. For more # information about tags in Lightsail, see the [Amazon Lightsail # Developer Guide][1]. # # # # [1]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags # @return [Array] # # @!attribute [rw] engine # The software of the database snapshot (for example, `MySQL`) # @return [String] # # @!attribute [rw] engine_version # The database engine version for the database snapshot (for example, # `5.7.23`). # @return [String] # # @!attribute [rw] size_in_gb # The size of the disk in GB (for example, `32`) for the database # snapshot. # @return [Integer] # # @!attribute [rw] state # The state of the database snapshot. # @return [String] # # @!attribute [rw] from_relational_database_name # The name of the source database from which the database snapshot was # created. # @return [String] # # @!attribute [rw] from_relational_database_arn # The Amazon Resource Name (ARN) of the database from which the # database snapshot was created. # @return [String] # # @!attribute [rw] from_relational_database_bundle_id # The bundle ID of the database from which the database snapshot was # created. # @return [String] # # @!attribute [rw] from_relational_database_blueprint_id # The blueprint ID of the database from which the database snapshot # was created. A blueprint describes the major engine version of a # database. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/RelationalDatabaseSnapshot AWS API Documentation # class RelationalDatabaseSnapshot < Struct.new( :name, :arn, :support_code, :created_at, :location, :resource_type, :tags, :engine, :engine_version, :size_in_gb, :state, :from_relational_database_name, :from_relational_database_arn, :from_relational_database_bundle_id, :from_relational_database_blueprint_id) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass ReleaseStaticIpRequest # data as a hash: # # { # static_ip_name: "ResourceName", # required # } # # @!attribute [rw] static_ip_name # The name of the static IP to delete. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/ReleaseStaticIpRequest AWS API Documentation # class ReleaseStaticIpRequest < Struct.new( :static_ip_name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] operations # An array of objects that describe the result of the action, such as # the status of the request, the timestamp of the request, and the # resources affected by the request. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/ReleaseStaticIpResult AWS API Documentation # class ReleaseStaticIpResult < Struct.new( :operations) SENSITIVE = [] include Aws::Structure end # Describes the status of a SSL/TLS certificate renewal managed by # Amazon Lightsail. # # @!attribute [rw] domain_validation_records # An array of objects that describe the domain validation records of # the certificate. # @return [Array] # # @!attribute [rw] renewal_status # The renewal status of the certificate. # # The following renewal status are possible: # # * PendingAutoRenewal - Lightsail is attempting # to automatically validate the domain names of the certificate. No # further action is required. # # * PendingValidation - Lightsail couldn't # automatically validate one or more domain names of the # certificate. You must take action to validate these domain names # or the certificate won't be renewed. Check to make sure your # certificate's domain validation records exist in your domain's # DNS, and that your certificate remains in use. # # * Success - All domain names in the # certificate are validated, and Lightsail renewed the certificate. # No further action is required. # # * Failed - One or more domain names were not # validated before the certificate expired, and Lightsail did not # renew the certificate. You can request a new certificate using the # `CreateCertificate` action. # @return [String] # # @!attribute [rw] renewal_status_reason # The reason for the renewal status of the certificate. # @return [String] # # @!attribute [rw] updated_at # The timestamp when the certificate was last updated. # @return [Time] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/RenewalSummary AWS API Documentation # class RenewalSummary < Struct.new( :domain_validation_records, :renewal_status, :renewal_status_reason, :updated_at) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass ResetDistributionCacheRequest # data as a hash: # # { # distribution_name: "ResourceName", # } # # @!attribute [rw] distribution_name # The name of the distribution for which to reset cache. # # Use the `GetDistributions` action to get a list of distribution # names that you can specify. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/ResetDistributionCacheRequest AWS API Documentation # class ResetDistributionCacheRequest < Struct.new( :distribution_name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] status # The status of the reset cache request. # @return [String] # # @!attribute [rw] create_time # The timestamp of the reset cache request (e.g., `1479734909.17`) in # Unix time format. # @return [Time] # # @!attribute [rw] operation # An array of objects that describe the result of the action, such as # the status of the request, the timestamp of the request, and the # resources affected by the request. # @return [Types::Operation] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/ResetDistributionCacheResult AWS API Documentation # class ResetDistributionCacheResult < Struct.new( :status, :create_time, :operation) SENSITIVE = [] include Aws::Structure end # Describes the resource location. # # @!attribute [rw] availability_zone # The Availability Zone. Follows the format `us-east-2a` # (case-sensitive). # @return [String] # # @!attribute [rw] region_name # The AWS Region name. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/ResourceLocation AWS API Documentation # class ResourceLocation < Struct.new( :availability_zone, :region_name) SENSITIVE = [] include Aws::Structure end # Describes an Amazon Lightsail instance that has access to a Lightsail # bucket. # # @!attribute [rw] name # The name of the Lightsail instance. # @return [String] # # @!attribute [rw] resource_type # The Lightsail resource type (for example, `Instance`). # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/ResourceReceivingAccess AWS API Documentation # class ResourceReceivingAccess < Struct.new( :name, :resource_type) SENSITIVE = [] include Aws::Structure end # Describes the domain name system (DNS) records to add to your # domain's DNS to validate it for an Amazon Lightsail certificate. # # @!attribute [rw] name # The name of the record. # @return [String] # # @!attribute [rw] type # The DNS record type. # @return [String] # # @!attribute [rw] value # The value for the DNS record. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/ResourceRecord AWS API Documentation # class ResourceRecord < Struct.new( :name, :type, :value) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass SendContactMethodVerificationRequest # data as a hash: # # { # protocol: "Email", # required, accepts Email # } # # @!attribute [rw] protocol # The protocol to verify, such as `Email` or `SMS` (text messaging). # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/SendContactMethodVerificationRequest AWS API Documentation # class SendContactMethodVerificationRequest < Struct.new( :protocol) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] operations # An array of objects that describe the result of the action, such as # the status of the request, the timestamp of the request, and the # resources affected by the request. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/SendContactMethodVerificationResult AWS API Documentation # class SendContactMethodVerificationResult < Struct.new( :operations) SENSITIVE = [] include Aws::Structure end # A general service exception. # # @!attribute [rw] code # @return [String] # # @!attribute [rw] docs # @return [String] # # @!attribute [rw] message # @return [String] # # @!attribute [rw] tip # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/ServiceException AWS API Documentation # class ServiceException < Struct.new( :code, :docs, :message, :tip) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass SetIpAddressTypeRequest # data as a hash: # # { # resource_type: "ContainerService", # required, accepts ContainerService, Instance, StaticIp, KeyPair, InstanceSnapshot, Domain, PeeredVpc, LoadBalancer, LoadBalancerTlsCertificate, Disk, DiskSnapshot, RelationalDatabase, RelationalDatabaseSnapshot, ExportSnapshotRecord, CloudFormationStackRecord, Alarm, ContactMethod, Distribution, Certificate, Bucket # resource_name: "ResourceName", # required # ip_address_type: "dualstack", # required, accepts dualstack, ipv4 # } # # @!attribute [rw] resource_type # The resource type. # # The possible values are `Distribution`, `Instance`, and # `LoadBalancer`. # # Distribution-related APIs are available only in the N. Virginia # (`us-east-1`) AWS Region. Set your AWS Region configuration to # `us-east-1` to create, view, or edit distributions. # # # @return [String] # # @!attribute [rw] resource_name # The name of the resource for which to set the IP address type. # @return [String] # # @!attribute [rw] ip_address_type # The IP address type to set for the specified resource. # # The possible values are `ipv4` for IPv4 only, and `dualstack` for # IPv4 and IPv6. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/SetIpAddressTypeRequest AWS API Documentation # class SetIpAddressTypeRequest < Struct.new( :resource_type, :resource_name, :ip_address_type) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] operations # An array of objects that describe the result of the action, such as # the status of the request, the timestamp of the request, and the # resources affected by the request. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/SetIpAddressTypeResult AWS API Documentation # class SetIpAddressTypeResult < Struct.new( :operations) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass SetResourceAccessForBucketRequest # data as a hash: # # { # resource_name: "ResourceName", # required # bucket_name: "BucketName", # required # access: "allow", # required, accepts allow, deny # } # # @!attribute [rw] resource_name # The name of the Lightsail instance for which to set bucket access. # The instance must be in a running or stopped state. # @return [String] # # @!attribute [rw] bucket_name # The name of the bucket for which to set access to another Lightsail # resource. # @return [String] # # @!attribute [rw] access # The access setting. # # The following access settings are available: # # * `allow` - Allows access to the bucket and its objects. # # * `deny` - Denies access to the bucket and its objects. Use this # setting to remove access for a resource previously set to `allow`. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/SetResourceAccessForBucketRequest AWS API Documentation # class SetResourceAccessForBucketRequest < Struct.new( :resource_name, :bucket_name, :access) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] operations # An array of objects that describe the result of the action, such as # the status of the request, the timestamp of the request, and the # resources affected by the request. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/SetResourceAccessForBucketResult AWS API Documentation # class SetResourceAccessForBucketResult < Struct.new( :operations) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass StartInstanceRequest # data as a hash: # # { # instance_name: "ResourceName", # required # } # # @!attribute [rw] instance_name # The name of the instance (a virtual private server) to start. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/StartInstanceRequest AWS API Documentation # class StartInstanceRequest < Struct.new( :instance_name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] operations # An array of objects that describe the result of the action, such as # the status of the request, the timestamp of the request, and the # resources affected by the request. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/StartInstanceResult AWS API Documentation # class StartInstanceResult < Struct.new( :operations) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass StartRelationalDatabaseRequest # data as a hash: # # { # relational_database_name: "ResourceName", # required # } # # @!attribute [rw] relational_database_name # The name of your database to start. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/StartRelationalDatabaseRequest AWS API Documentation # class StartRelationalDatabaseRequest < Struct.new( :relational_database_name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] operations # An array of objects that describe the result of the action, such as # the status of the request, the timestamp of the request, and the # resources affected by the request. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/StartRelationalDatabaseResult AWS API Documentation # class StartRelationalDatabaseResult < Struct.new( :operations) SENSITIVE = [] include Aws::Structure end # Describes a static IP. # # @!attribute [rw] name # The name of the static IP (e.g., `StaticIP-Ohio-EXAMPLE`). # @return [String] # # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the static IP (e.g., # `arn:aws:lightsail:us-east-2:123456789101:StaticIp/9cbb4a9e-f8e3-4dfe-b57e-12345EXAMPLE`). # @return [String] # # @!attribute [rw] support_code # The support code. Include this code in your email to support when # you have questions about an instance or another resource in # Lightsail. This code enables our support team to look up your # Lightsail information more easily. # @return [String] # # @!attribute [rw] created_at # The timestamp when the static IP was created (e.g., # `1479735304.222`). # @return [Time] # # @!attribute [rw] location # The region and Availability Zone where the static IP was created. # @return [Types::ResourceLocation] # # @!attribute [rw] resource_type # The resource type (usually `StaticIp`). # @return [String] # # @!attribute [rw] ip_address # The static IP address. # @return [String] # # @!attribute [rw] attached_to # The instance where the static IP is attached (e.g., # `Amazon_Linux-1GB-Ohio-1`). # @return [String] # # @!attribute [rw] is_attached # A Boolean value indicating whether the static IP is attached. # @return [Boolean] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/StaticIp AWS API Documentation # class StaticIp < Struct.new( :name, :arn, :support_code, :created_at, :location, :resource_type, :ip_address, :attached_to, :is_attached) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass StopInstanceRequest # data as a hash: # # { # instance_name: "ResourceName", # required # force: false, # } # # @!attribute [rw] instance_name # The name of the instance (a virtual private server) to stop. # @return [String] # # @!attribute [rw] force # When set to `True`, forces a Lightsail instance that is stuck in a # `stopping` state to stop. # # Only use the `force` parameter if your instance is stuck in the # `stopping` state. In any other state, your instance should stop # normally without adding this parameter to your API request. # @return [Boolean] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/StopInstanceRequest AWS API Documentation # class StopInstanceRequest < Struct.new( :instance_name, :force) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] operations # An array of objects that describe the result of the action, such as # the status of the request, the timestamp of the request, and the # resources affected by the request. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/StopInstanceResult AWS API Documentation # class StopInstanceResult < Struct.new( :operations) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass StopRelationalDatabaseRequest # data as a hash: # # { # relational_database_name: "ResourceName", # required # relational_database_snapshot_name: "ResourceName", # } # # @!attribute [rw] relational_database_name # The name of your database to stop. # @return [String] # # @!attribute [rw] relational_database_snapshot_name # The name of your new database snapshot to be created before stopping # your database. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/StopRelationalDatabaseRequest AWS API Documentation # class StopRelationalDatabaseRequest < Struct.new( :relational_database_name, :relational_database_snapshot_name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] operations # An array of objects that describe the result of the action, such as # the status of the request, the timestamp of the request, and the # resources affected by the request. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/StopRelationalDatabaseResult AWS API Documentation # class StopRelationalDatabaseResult < Struct.new( :operations) SENSITIVE = [] include Aws::Structure end # Describes a tag key and optional value assigned to an Amazon Lightsail # resource. # # For more information about tags in Lightsail, see the [Amazon # Lightsail Developer Guide][1]. # # # # [1]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags # # @note When making an API call, you may pass Tag # data as a hash: # # { # key: "TagKey", # value: "TagValue", # } # # @!attribute [rw] key # The key of the tag. # # Constraints: Tag keys accept a maximum of 128 letters, numbers, # spaces in UTF-8, or the following characters: + - = . \_ : / @ # @return [String] # # @!attribute [rw] value # The value of the tag. # # Constraints: Tag values accept a maximum of 256 letters, numbers, # spaces in UTF-8, or the following characters: + - = . \_ : / @ # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/Tag AWS API Documentation # class Tag < Struct.new( :key, :value) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass TagResourceRequest # data as a hash: # # { # resource_name: "ResourceName", # required # resource_arn: "ResourceArn", # tags: [ # required # { # key: "TagKey", # value: "TagValue", # }, # ], # } # # @!attribute [rw] resource_name # The name of the resource to which you are adding tags. # @return [String] # # @!attribute [rw] resource_arn # The Amazon Resource Name (ARN) of the resource to which you want to # add a tag. # @return [String] # # @!attribute [rw] tags # The tag key and optional value. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/TagResourceRequest AWS API Documentation # class TagResourceRequest < Struct.new( :resource_name, :resource_arn, :tags) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] operations # An array of objects that describe the result of the action, such as # the status of the request, the timestamp of the request, and the # resources affected by the request. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/TagResourceResult AWS API Documentation # class TagResourceResult < Struct.new( :operations) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass TestAlarmRequest # data as a hash: # # { # alarm_name: "ResourceName", # required # state: "OK", # required, accepts OK, ALARM, INSUFFICIENT_DATA # } # # @!attribute [rw] alarm_name # The name of the alarm to test. # @return [String] # # @!attribute [rw] state # The alarm state to test. # # An alarm has the following possible states that can be tested: # # * `ALARM` - The metric is outside of the defined threshold. # # * `INSUFFICIENT_DATA` - The alarm has just started, the metric is # not available, or not enough data is available for the metric to # determine the alarm state. # # * `OK` - The metric is within the defined threshold. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/TestAlarmRequest AWS API Documentation # class TestAlarmRequest < Struct.new( :alarm_name, :state) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] operations # An array of objects that describe the result of the action, such as # the status of the request, the timestamp of the request, and the # resources affected by the request. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/TestAlarmResult AWS API Documentation # class TestAlarmResult < Struct.new( :operations) SENSITIVE = [] include Aws::Structure end # Lightsail throws this exception when the user has not been # authenticated. # # @!attribute [rw] code # @return [String] # # @!attribute [rw] docs # @return [String] # # @!attribute [rw] message # @return [String] # # @!attribute [rw] tip # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/UnauthenticatedException AWS API Documentation # class UnauthenticatedException < Struct.new( :code, :docs, :message, :tip) SENSITIVE = [] include Aws::Structure end # @api private # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/UnpeerVpcRequest AWS API Documentation # class UnpeerVpcRequest < Aws::EmptyStructure; end # @!attribute [rw] operation # An array of objects that describe the result of the action, such as # the status of the request, the timestamp of the request, and the # resources affected by the request. # @return [Types::Operation] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/UnpeerVpcResult AWS API Documentation # class UnpeerVpcResult < Struct.new( :operation) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass UntagResourceRequest # data as a hash: # # { # resource_name: "ResourceName", # required # resource_arn: "ResourceArn", # tag_keys: ["TagKey"], # required # } # # @!attribute [rw] resource_name # The name of the resource from which you are removing a tag. # @return [String] # # @!attribute [rw] resource_arn # The Amazon Resource Name (ARN) of the resource from which you want # to remove a tag. # @return [String] # # @!attribute [rw] tag_keys # The tag keys to delete from the specified resource. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/UntagResourceRequest AWS API Documentation # class UntagResourceRequest < Struct.new( :resource_name, :resource_arn, :tag_keys) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] operations # An array of objects that describe the result of the action, such as # the status of the request, the timestamp of the request, and the # resources affected by the request. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/UntagResourceResult AWS API Documentation # class UntagResourceResult < Struct.new( :operations) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass UpdateBucketBundleRequest # data as a hash: # # { # bucket_name: "BucketName", # required # bundle_id: "NonEmptyString", # required # } # # @!attribute [rw] bucket_name # The name of the bucket for which to update the bundle. # @return [String] # # @!attribute [rw] bundle_id # The ID of the new bundle to apply to the bucket. # # Use the GetBucketBundles action to get a list of bundle IDs that you # can specify. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/UpdateBucketBundleRequest AWS API Documentation # class UpdateBucketBundleRequest < Struct.new( :bucket_name, :bundle_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] operations # An array of objects that describe the result of the action, such as # the status of the request, the timestamp of the request, and the # resources affected by the request. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/UpdateBucketBundleResult AWS API Documentation # class UpdateBucketBundleResult < Struct.new( :operations) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass UpdateBucketRequest # data as a hash: # # { # bucket_name: "BucketName", # required # access_rules: { # get_object: "public", # accepts public, private # allow_public_overrides: false, # }, # versioning: "NonEmptyString", # readonly_access_accounts: ["NonEmptyString"], # access_log_config: { # enabled: false, # required # destination: "BucketName", # prefix: "BucketAccessLogPrefix", # }, # } # # @!attribute [rw] bucket_name # The name of the bucket to update. # @return [String] # # @!attribute [rw] access_rules # An object that sets the public accessibility of objects in the # specified bucket. # @return [Types::AccessRules] # # @!attribute [rw] versioning # Specifies whether to enable or suspend versioning of objects in the # bucket. # # The following options can be specified: # # * `Enabled` - Enables versioning of objects in the specified bucket. # # * `Suspended` - Suspends versioning of objects in the specified # bucket. Existing object versions are retained. # @return [String] # # @!attribute [rw] readonly_access_accounts # An array of strings to specify the AWS account IDs that can access # the bucket. # # You can give a maximum of 10 AWS accounts access to a bucket. # @return [Array] # # @!attribute [rw] access_log_config # An object that describes the access log configuration for the # bucket. # @return [Types::BucketAccessLogConfig] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/UpdateBucketRequest AWS API Documentation # class UpdateBucketRequest < Struct.new( :bucket_name, :access_rules, :versioning, :readonly_access_accounts, :access_log_config) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bucket # An object that describes the bucket that is updated. # @return [Types::Bucket] # # @!attribute [rw] operations # An array of objects that describe the result of the action, such as # the status of the request, the timestamp of the request, and the # resources affected by the request. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/UpdateBucketResult AWS API Documentation # class UpdateBucketResult < Struct.new( :bucket, :operations) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass UpdateContainerServiceRequest # data as a hash: # # { # service_name: "ContainerServiceName", # required # power: "nano", # accepts nano, micro, small, medium, large, xlarge # scale: 1, # is_disabled: false, # public_domain_names: { # "string" => ["string"], # }, # } # # @!attribute [rw] service_name # The name of the container service to update. # @return [String] # # @!attribute [rw] power # 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. # @return [String] # # @!attribute [rw] scale # 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. # @return [Integer] # # @!attribute [rw] is_disabled # A Boolean value to indicate whether the container service is # disabled. # @return [Boolean] # # @!attribute [rw] public_domain_names # 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. # @return [Hash>] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/UpdateContainerServiceRequest AWS API Documentation # class UpdateContainerServiceRequest < Struct.new( :service_name, :power, :scale, :is_disabled, :public_domain_names) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] container_service # An object that describes a container service. # @return [Types::ContainerService] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/UpdateContainerServiceResult AWS API Documentation # class UpdateContainerServiceResult < Struct.new( :container_service) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass UpdateDistributionBundleRequest # data as a hash: # # { # distribution_name: "ResourceName", # bundle_id: "string", # } # # @!attribute [rw] distribution_name # The name of the distribution for which to update the bundle. # # Use the `GetDistributions` action to get a list of distribution # names that you can specify. # @return [String] # # @!attribute [rw] bundle_id # The bundle ID of the new bundle to apply to your distribution. # # Use the `GetDistributionBundles` action to get a list of # distribution bundle IDs that you can specify. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/UpdateDistributionBundleRequest AWS API Documentation # class UpdateDistributionBundleRequest < Struct.new( :distribution_name, :bundle_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] operation # Describes the API operation. # @return [Types::Operation] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/UpdateDistributionBundleResult AWS API Documentation # class UpdateDistributionBundleResult < Struct.new( :operation) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass UpdateDistributionRequest # data as a hash: # # { # distribution_name: "ResourceName", # required # origin: { # name: "ResourceName", # region_name: "us-east-1", # accepts us-east-1, us-east-2, us-west-1, us-west-2, eu-west-1, eu-west-2, eu-west-3, eu-central-1, ca-central-1, ap-south-1, ap-southeast-1, ap-southeast-2, ap-northeast-1, ap-northeast-2, eu-north-1 # protocol_policy: "http-only", # accepts http-only, https-only # }, # default_cache_behavior: { # behavior: "dont-cache", # accepts dont-cache, cache # }, # cache_behavior_settings: { # default_ttl: 1, # minimum_ttl: 1, # maximum_ttl: 1, # allowed_http_methods: "NonEmptyString", # cached_http_methods: "NonEmptyString", # forwarded_cookies: { # option: "none", # accepts none, allow-list, all # cookies_allow_list: ["string"], # }, # forwarded_headers: { # option: "none", # accepts none, allow-list, all # headers_allow_list: ["Accept"], # accepts Accept, Accept-Charset, Accept-Datetime, Accept-Encoding, Accept-Language, Authorization, CloudFront-Forwarded-Proto, CloudFront-Is-Desktop-Viewer, CloudFront-Is-Mobile-Viewer, CloudFront-Is-SmartTV-Viewer, CloudFront-Is-Tablet-Viewer, CloudFront-Viewer-Country, Host, Origin, Referer # }, # forwarded_query_strings: { # option: false, # query_strings_allow_list: ["string"], # }, # }, # cache_behaviors: [ # { # path: "string", # behavior: "dont-cache", # accepts dont-cache, cache # }, # ], # is_enabled: false, # } # # @!attribute [rw] distribution_name # The name of the distribution to update. # # Use the `GetDistributions` action to get a list of distribution # names that you can specify. # @return [String] # # @!attribute [rw] origin # 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. # @return [Types::InputOrigin] # # @!attribute [rw] default_cache_behavior # An object that describes the default cache behavior for the # distribution. # @return [Types::CacheBehavior] # # @!attribute [rw] cache_behavior_settings # An object that describes the cache behavior settings for the # distribution. # # The `cacheBehaviorSettings` specified in your # `UpdateDistributionRequest` will replace your distribution's # existing settings. # # # @return [Types::CacheSettings] # # @!attribute [rw] cache_behaviors # An array of objects that describe the per-path cache behavior for # the distribution. # @return [Array] # # @!attribute [rw] is_enabled # Indicates whether to enable the distribution. # @return [Boolean] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/UpdateDistributionRequest AWS API Documentation # class UpdateDistributionRequest < Struct.new( :distribution_name, :origin, :default_cache_behavior, :cache_behavior_settings, :cache_behaviors, :is_enabled) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] operation # An array of objects that describe the result of the action, such as # the status of the request, the timestamp of the request, and the # resources affected by the request. # @return [Types::Operation] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/UpdateDistributionResult AWS API Documentation # class UpdateDistributionResult < Struct.new( :operation) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass UpdateDomainEntryRequest # data as a hash: # # { # domain_name: "DomainName", # required # domain_entry: { # required # id: "NonEmptyString", # name: "DomainName", # target: "string", # is_alias: false, # type: "DomainEntryType", # options: { # "DomainEntryOptionsKeys" => "string", # }, # }, # } # # @!attribute [rw] domain_name # The name of the domain recordset to update. # @return [String] # # @!attribute [rw] domain_entry # An array of key-value pairs containing information about the domain # entry. # @return [Types::DomainEntry] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/UpdateDomainEntryRequest AWS API Documentation # class UpdateDomainEntryRequest < Struct.new( :domain_name, :domain_entry) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] operations # An array of objects that describe the result of the action, such as # the status of the request, the timestamp of the request, and the # resources affected by the request. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/UpdateDomainEntryResult AWS API Documentation # class UpdateDomainEntryResult < Struct.new( :operations) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass UpdateLoadBalancerAttributeRequest # data as a hash: # # { # load_balancer_name: "ResourceName", # required # attribute_name: "HealthCheckPath", # required, accepts HealthCheckPath, SessionStickinessEnabled, SessionStickiness_LB_CookieDurationSeconds # attribute_value: "StringMax256", # required # } # # @!attribute [rw] load_balancer_name # The name of the load balancer that you want to modify (e.g., # `my-load-balancer`. # @return [String] # # @!attribute [rw] attribute_name # The name of the attribute you want to update. Valid values are # below. # @return [String] # # @!attribute [rw] attribute_value # The value that you want to specify for the attribute name. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/UpdateLoadBalancerAttributeRequest AWS API Documentation # class UpdateLoadBalancerAttributeRequest < Struct.new( :load_balancer_name, :attribute_name, :attribute_value) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] operations # An array of objects that describe the result of the action, such as # the status of the request, the timestamp of the request, and the # resources affected by the request. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/UpdateLoadBalancerAttributeResult AWS API Documentation # class UpdateLoadBalancerAttributeResult < Struct.new( :operations) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass UpdateRelationalDatabaseParametersRequest # data as a hash: # # { # relational_database_name: "ResourceName", # required # parameters: [ # required # { # allowed_values: "string", # apply_method: "string", # apply_type: "string", # data_type: "string", # description: "string", # is_modifiable: false, # parameter_name: "string", # parameter_value: "string", # }, # ], # } # # @!attribute [rw] relational_database_name # The name of your database for which to update parameters. # @return [String] # # @!attribute [rw] parameters # The database parameters to update. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/UpdateRelationalDatabaseParametersRequest AWS API Documentation # class UpdateRelationalDatabaseParametersRequest < Struct.new( :relational_database_name, :parameters) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] operations # An array of objects that describe the result of the action, such as # the status of the request, the timestamp of the request, and the # resources affected by the request. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/UpdateRelationalDatabaseParametersResult AWS API Documentation # class UpdateRelationalDatabaseParametersResult < Struct.new( :operations) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass UpdateRelationalDatabaseRequest # data as a hash: # # { # relational_database_name: "ResourceName", # required # master_user_password: "SensitiveString", # rotate_master_user_password: false, # preferred_backup_window: "string", # preferred_maintenance_window: "string", # enable_backup_retention: false, # disable_backup_retention: false, # publicly_accessible: false, # apply_immediately: false, # ca_certificate_identifier: "string", # } # # @!attribute [rw] relational_database_name # The name of your Lightsail database resource to update. # @return [String] # # @!attribute [rw] master_user_password # The password for the master user. The password can include any # printable ASCII character except "/", """, or "@". # # My**SQL** # # Constraints: Must contain from 8 to 41 characters. # # **PostgreSQL** # # Constraints: Must contain from 8 to 128 characters. # @return [String] # # @!attribute [rw] rotate_master_user_password # When `true`, the master user password is changed to a new strong # password generated by Lightsail. # # Use the `get relational database master user password` operation to # get the new password. # @return [Boolean] # # @!attribute [rw] preferred_backup_window # The daily time range during which automated backups are created for # your database if automated backups are enabled. # # Constraints: # # * Must be in the `hh24:mi-hh24:mi` format. # # Example: `16:00-16:30` # # * Specified in Coordinated Universal Time (UTC). # # * Must not conflict with the preferred maintenance window. # # * Must be at least 30 minutes. # @return [String] # # @!attribute [rw] preferred_maintenance_window # The weekly time range during which system maintenance can occur on # your database. # # The default is a 30-minute window selected at random from an 8-hour # block of time for each AWS Region, occurring on a random day of the # week. # # Constraints: # # * Must be in the `ddd:hh24:mi-ddd:hh24:mi` format. # # * Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun. # # * Must be at least 30 minutes. # # * Specified in Coordinated Universal Time (UTC). # # * Example: `Tue:17:00-Tue:17:30` # @return [String] # # @!attribute [rw] enable_backup_retention # When `true`, enables automated backup retention for your database. # # Updates are applied during the next maintenance window because this # can result in an outage. # @return [Boolean] # # @!attribute [rw] disable_backup_retention # When `true`, disables automated backup retention for your database. # # Disabling backup retention deletes all automated database backups. # Before disabling this, you may want to create a snapshot of your # database using the `create relational database snapshot` operation. # # Updates are applied during the next maintenance window because this # can result in an outage. # @return [Boolean] # # @!attribute [rw] publicly_accessible # Specifies the accessibility options for your database. A value of # `true` specifies a database that is available to resources outside # of your Lightsail account. A value of `false` specifies a database # that is available only to your Lightsail resources in the same # region as your database. # @return [Boolean] # # @!attribute [rw] apply_immediately # When `true`, applies changes immediately. When `false`, applies # changes during the preferred maintenance window. Some changes may # cause an outage. # # Default: `false` # @return [Boolean] # # @!attribute [rw] ca_certificate_identifier # Indicates the certificate that needs to be associated with the # database. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/UpdateRelationalDatabaseRequest AWS API Documentation # class UpdateRelationalDatabaseRequest < Struct.new( :relational_database_name, :master_user_password, :rotate_master_user_password, :preferred_backup_window, :preferred_maintenance_window, :enable_backup_retention, :disable_backup_retention, :publicly_accessible, :apply_immediately, :ca_certificate_identifier) SENSITIVE = [:master_user_password] include Aws::Structure end # @!attribute [rw] operations # An array of objects that describe the result of the action, such as # the status of the request, the timestamp of the request, and the # resources affected by the request. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/UpdateRelationalDatabaseResult AWS API Documentation # class UpdateRelationalDatabaseResult < Struct.new( :operations) SENSITIVE = [] include Aws::Structure end end end