awscc.lightsail_instance

Filters

  • event

  • reduce

  • value

Actions

delete

Parent base class for filters and actions.

properties:
  type:
    enum:
    - delete
required:
- type

Permissions - lightsail:GetInstances, lightsail:GetInstance, lightsail:DeleteInstance

update

Parent base class for filters and actions.

definitions:
  AddOn:
    additionalProperties: false
    description: A addon associate with a resource.
    properties:
      AddOnType:
        description: The add-on type
        maxLength: 128
        minLength: 1
        type: string
      AutoSnapshotAddOnRequest:
        additionalProperties: false
        description: An object that represents additional parameters when enabling
          or modifying the automatic snapshot add-on
        properties:
          SnapshotTimeOfDay:
            description: The daily time when an automatic snapshot will be created.
            pattern: ^[0-9]{2}:00$
            type: string
        type: object
      Status:
        description: Status of the Addon
        enum:
        - Enabling
        - Disabling
        - Enabled
        - Terminating
        - Terminated
        - Disabled
        - Failed
        type: string
    required:
    - AddOnType
    type: object
  AutoSnapshotAddOn:
    additionalProperties: false
    description: An object that represents additional parameters when enabling or
      modifying the automatic snapshot add-on
    properties:
      SnapshotTimeOfDay:
        description: The daily time when an automatic snapshot will be created.
        pattern: ^[0-9]{2}:00$
        type: string
    type: object
  Disk:
    additionalProperties: false
    description: Disk associated with the Instance.
    properties:
      AttachedTo:
        description: Instance attached to the disk.
        type: string
      AttachmentState:
        description: Attachment state of the disk.
        type: string
      DiskName:
        description: The names to use for your new Lightsail disk.
        maxLength: 254
        minLength: 1
        pattern: ^[a-zA-Z0-9][\w\-.]*[a-zA-Z0-9]$
        type: string
      IOPS:
        description: IOPS of disk.
        type: integer
      IsSystemDisk:
        description: Is the Attached disk is the system disk of the Instance.
        type: boolean
      Path:
        description: Path of the disk attached to the instance.
        type: string
      SizeInGb:
        description: Size of the disk attached to the Instance.
        type: string
    required:
    - DiskName
    - Path
    type: object
  Hardware:
    additionalProperties: false
    description: Hardware of the Instance.
    properties:
      CpuCount:
        description: CPU count of the Instance.
        type: integer
      Disks:
        description: Disks attached to the Instance.
        insertionOrder: false
        items:
          additionalProperties: false
          description: Disk associated with the Instance.
          properties:
            AttachedTo:
              description: Instance attached to the disk.
              type: string
            AttachmentState:
              description: Attachment state of the disk.
              type: string
            DiskName:
              description: The names to use for your new Lightsail disk.
              maxLength: 254
              minLength: 1
              pattern: ^[a-zA-Z0-9][\w\-.]*[a-zA-Z0-9]$
              type: string
            IOPS:
              description: IOPS of disk.
              type: integer
            IsSystemDisk:
              description: Is the Attached disk is the system disk of the Instance.
              type: boolean
            Path:
              description: Path of the disk attached to the instance.
              type: string
            SizeInGb:
              description: Size of the disk attached to the Instance.
              type: string
          required:
          - DiskName
          - Path
          type: object
        type: array
        uniqueItems: true
      RamSizeInGb:
        description: RAM Size of the Instance.
        type: integer
    type: object
  Location:
    additionalProperties: false
    description: Location of a resource.
    properties:
      AvailabilityZone:
        description: 'The Availability Zone in which to create your instance. Use
          the following format: us-east-2a (case sensitive). Be sure to add the include
          Availability Zones parameter to your request.'
        type: string
      RegionName:
        description: The Region Name in which to create your instance.
        type: string
    type: object
  MonthlyTransfer:
    additionalProperties: false
    description: Monthly Transfer of the Instance.
    properties:
      GbPerMonthAllocated:
        description: GbPerMonthAllocated of the Instance.
        type: string
    type: object
  Networking:
    additionalProperties: false
    description: Networking of the Instance.
    properties:
      MonthlyTransfer:
        additionalProperties: false
        description: Monthly Transfer of the Instance.
        properties:
          GbPerMonthAllocated:
            description: GbPerMonthAllocated of the Instance.
            type: string
        type: object
      Ports:
        description: Ports to the Instance.
        insertionOrder: false
        items:
          additionalProperties: false
          description: Port of the Instance.
          properties:
            AccessDirection:
              description: Access Direction for Protocol of the Instance(inbound/outbound).
              type: string
            AccessFrom:
              description: Access From Protocol of the Instance.
              type: string
            AccessType:
              description: Access Type Protocol of the Instance.
              type: string
            CidrListAliases:
              description: cidr List Aliases
              insertionOrder: false
              items:
                type: string
              type: array
            Cidrs:
              description: cidrs
              insertionOrder: false
              items:
                type: string
              type: array
            CommonName:
              description: CommonName for Protocol of the Instance.
              type: string
            FromPort:
              description: From Port of the Instance.
              type: integer
            Ipv6Cidrs:
              description: IPv6 Cidrs
              insertionOrder: false
              items:
                type: string
              type: array
            Protocol:
              description: Port Protocol of the Instance.
              type: string
            ToPort:
              description: To Port of the Instance.
              type: integer
          type: object
        type: array
        uniqueItems: true
    required:
    - Ports
    type: object
  Port:
    additionalProperties: false
    description: Port of the Instance.
    properties:
      AccessDirection:
        description: Access Direction for Protocol of the Instance(inbound/outbound).
        type: string
      AccessFrom:
        description: Access From Protocol of the Instance.
        type: string
      AccessType:
        description: Access Type Protocol of the Instance.
        type: string
      CidrListAliases:
        description: cidr List Aliases
        insertionOrder: false
        items:
          type: string
        type: array
      Cidrs:
        description: cidrs
        insertionOrder: false
        items:
          type: string
        type: array
      CommonName:
        description: CommonName for Protocol of the Instance.
        type: string
      FromPort:
        description: From Port of the Instance.
        type: integer
      Ipv6Cidrs:
        description: IPv6 Cidrs
        insertionOrder: false
        items:
          type: string
        type: array
      Protocol:
        description: Port Protocol of the Instance.
        type: string
      ToPort:
        description: To Port of the Instance.
        type: integer
    type: object
  State:
    additionalProperties: false
    description: Current State of the Instance.
    properties:
      Code:
        description: Status code of the Instance.
        type: integer
      Name:
        description: Status code of the Instance.
        type: string
    type: object
  Tag:
    additionalProperties: false
    description: A key-value pair to associate with a resource.
    properties:
      Key:
        description: 'The key name of the tag. You can specify a value that is 1 to
          128 Unicode characters in length and cannot be prefixed with aws:. You can
          use any of the following characters: the set of Unicode letters, digits,
          whitespace, _, ., /, =, +, and -.'
        maxLength: 128
        minLength: 1
        type: string
      Value:
        description: 'The value for the tag. You can specify a value that is 0 to
          256 Unicode characters in length and cannot be prefixed with aws:. You can
          use any of the following characters: the set of Unicode letters, digits,
          whitespace, _, ., /, =, +, and -.'
        maxLength: 256
        minLength: 0
        type: string
    required:
    - Key
    type: object
  cidrListAliases:
    description: cidr List Aliases
    insertionOrder: false
    items:
      type: string
    type: array
  cidrs:
    description: cidrs
    insertionOrder: false
    items:
      type: string
    type: array
  ipv6Cidrs:
    description: IPv6 Cidrs
    insertionOrder: false
    items:
      type: string
    type: array
properties:
  AddOns:
    description: An array of objects representing the add-ons to enable for the new
      instance.
    insertionOrder: false
    items:
      additionalProperties: false
      description: A addon associate with a resource.
      properties:
        AddOnType:
          description: The add-on type
          maxLength: 128
          minLength: 1
          type: string
        AutoSnapshotAddOnRequest:
          additionalProperties: false
          description: An object that represents additional parameters when enabling
            or modifying the automatic snapshot add-on
          properties:
            SnapshotTimeOfDay:
              description: The daily time when an automatic snapshot will be created.
              pattern: ^[0-9]{2}:00$
              type: string
          type: object
        Status:
          description: Status of the Addon
          enum:
          - Enabling
          - Disabling
          - Enabled
          - Terminating
          - Terminated
          - Disabled
          - Failed
          type: string
      required:
      - AddOnType
      type: object
    type: array
  Hardware:
    additionalProperties: false
    description: Hardware of the Instance.
    properties:
      CpuCount:
        description: CPU count of the Instance.
        type: integer
      Disks:
        description: Disks attached to the Instance.
        insertionOrder: false
        items:
          additionalProperties: false
          description: Disk associated with the Instance.
          properties:
            AttachedTo:
              description: Instance attached to the disk.
              type: string
            AttachmentState:
              description: Attachment state of the disk.
              type: string
            DiskName:
              description: The names to use for your new Lightsail disk.
              maxLength: 254
              minLength: 1
              pattern: ^[a-zA-Z0-9][\w\-.]*[a-zA-Z0-9]$
              type: string
            IOPS:
              description: IOPS of disk.
              type: integer
            IsSystemDisk:
              description: Is the Attached disk is the system disk of the Instance.
              type: boolean
            Path:
              description: Path of the disk attached to the instance.
              type: string
            SizeInGb:
              description: Size of the disk attached to the Instance.
              type: string
          required:
          - DiskName
          - Path
          type: object
        type: array
        uniqueItems: true
      RamSizeInGb:
        description: RAM Size of the Instance.
        type: integer
    type: object
  KeyPairName:
    description: The name of your key pair.
    type: string
  Location:
    additionalProperties: false
    description: Location of a resource.
    properties:
      AvailabilityZone:
        description: 'The Availability Zone in which to create your instance. Use
          the following format: us-east-2a (case sensitive). Be sure to add the include
          Availability Zones parameter to your request.'
        type: string
      RegionName:
        description: The Region Name in which to create your instance.
        type: string
    type: object
  Networking:
    additionalProperties: false
    description: Networking of the Instance.
    properties:
      MonthlyTransfer:
        additionalProperties: false
        description: Monthly Transfer of the Instance.
        properties:
          GbPerMonthAllocated:
            description: GbPerMonthAllocated of the Instance.
            type: string
        type: object
      Ports:
        description: Ports to the Instance.
        insertionOrder: false
        items:
          additionalProperties: false
          description: Port of the Instance.
          properties:
            AccessDirection:
              description: Access Direction for Protocol of the Instance(inbound/outbound).
              type: string
            AccessFrom:
              description: Access From Protocol of the Instance.
              type: string
            AccessType:
              description: Access Type Protocol of the Instance.
              type: string
            CidrListAliases:
              description: cidr List Aliases
              insertionOrder: false
              items:
                type: string
              type: array
            Cidrs:
              description: cidrs
              insertionOrder: false
              items:
                type: string
              type: array
            CommonName:
              description: CommonName for Protocol of the Instance.
              type: string
            FromPort:
              description: From Port of the Instance.
              type: integer
            Ipv6Cidrs:
              description: IPv6 Cidrs
              insertionOrder: false
              items:
                type: string
              type: array
            Protocol:
              description: Port Protocol of the Instance.
              type: string
            ToPort:
              description: To Port of the Instance.
              type: integer
          type: object
        type: array
        uniqueItems: true
    required:
    - Ports
    type: object
  State:
    additionalProperties: false
    description: Current State of the Instance.
    properties:
      Code:
        description: Status code of the Instance.
        type: integer
      Name:
        description: Status code of the Instance.
        type: string
    type: object
  Tags:
    description: An array of key-value pairs to apply to this resource.
    insertionOrder: false
    items:
      additionalProperties: false
      description: A key-value pair to associate with a resource.
      properties:
        Key:
          description: 'The key name of the tag. You can specify a value that is 1
            to 128 Unicode characters in length and cannot be prefixed with aws:.
            You can use any of the following characters: the set of Unicode letters,
            digits, whitespace, _, ., /, =, +, and -.'
          maxLength: 128
          minLength: 1
          type: string
        Value:
          description: 'The value for the tag. You can specify a value that is 0 to
            256 Unicode characters in length and cannot be prefixed with aws:. You
            can use any of the following characters: the set of Unicode letters, digits,
            whitespace, _, ., /, =, +, and -.'
          maxLength: 256
          minLength: 0
          type: string
      required:
      - Key
      type: object
    type: array
    uniqueItems: true
  UserData:
    description: 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.
    type: string
  type:
    enum:
    - update

Permissions - lightsail:GetInstances, lightsail:GetInstance, lightsail:DeleteInstance, lightsail:EnableAddOn, lightsail:DisableAddOn, lightsail:PutInstancePublicPorts, lightsail:AttachDisk, lightsail:DetachDisk, lightsail:StartInstance, lightsail:StopInstance, lightsail:GetDisk, lightsail:TagResource, lightsail:UntagResource