Class: Aws::EC2::Types::CreateInstanceEventWindowRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb

Overview

Note:

When making an API call, you may pass CreateInstanceEventWindowRequest data as a hash:

{
  dry_run: false,
  name: "String",
  time_ranges: [
    {
      start_week_day: "sunday", # accepts sunday, monday, tuesday, wednesday, thursday, friday, saturday
      start_hour: 1,
      end_week_day: "sunday", # accepts sunday, monday, tuesday, wednesday, thursday, friday, saturday
      end_hour: 1,
    },
  ],
  cron_expression: "InstanceEventWindowCronExpression",
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts capacity-reservation, client-vpn-endpoint, customer-gateway, carrier-gateway, dedicated-host, dhcp-options, egress-only-internet-gateway, elastic-ip, elastic-gpu, export-image-task, export-instance-task, fleet, fpga-image, host-reservation, image, import-image-task, import-snapshot-task, instance, instance-event-window, internet-gateway, ipv4pool-ec2, ipv6pool-ec2, key-pair, launch-template, local-gateway, local-gateway-route-table, local-gateway-virtual-interface, local-gateway-virtual-interface-group, local-gateway-route-table-vpc-association, local-gateway-route-table-virtual-interface-group-association, natgateway, network-acl, network-interface, network-insights-analysis, network-insights-path, placement-group, prefix-list, replace-root-volume-task, reserved-instances, route-table, security-group, security-group-rule, snapshot, spot-fleet-request, spot-instances-request, subnet, traffic-mirror-filter, traffic-mirror-session, traffic-mirror-target, transit-gateway, transit-gateway-attachment, transit-gateway-connect-peer, transit-gateway-multicast-domain, transit-gateway-route-table, volume, vpc, vpc-endpoint, vpc-endpoint-service, vpc-peering-connection, vpn-connection, vpn-gateway, vpc-flow-log
      tags: [
        {
          key: "String",
          value: "String",
        },
      ],
    },
  ],
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#cron_expressionString

The cron expression for the event window, for example, * 0-4,20-23 * * 1,5. If you specify a cron expression, you can't specify a time range.

Constraints:

  • Only hour and day of the week values are supported.

  • For day of the week values, you can specify either integers 0 through 6, or alternative single values SUN through SAT.

  • The minute, month, and year must be specified by *.

  • The hour value must be one or a multiple range, for example, 0-4 or 0-4,20-23.

  • Each hour range must be >= 2 hours, for example, 0-2 or 20-23.

  • The event window must be >= 4 hours. The combined total time ranges in the event window must be >= 4 hours.

For more information about cron expressions, see cron on the Wikipedia website.

Returns:

  • (String)


7326
7327
7328
7329
7330
7331
7332
7333
7334
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 7326

class CreateInstanceEventWindowRequest < Struct.new(
  :dry_run,
  :name,
  :time_ranges,
  :cron_expression,
  :tag_specifications)
  SENSITIVE = []
  include Aws::Structure
end

#dry_runBoolean

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Returns:

  • (Boolean)


7326
7327
7328
7329
7330
7331
7332
7333
7334
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 7326

class CreateInstanceEventWindowRequest < Struct.new(
  :dry_run,
  :name,
  :time_ranges,
  :cron_expression,
  :tag_specifications)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

The name of the event window.

Returns:

  • (String)


7326
7327
7328
7329
7330
7331
7332
7333
7334
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 7326

class CreateInstanceEventWindowRequest < Struct.new(
  :dry_run,
  :name,
  :time_ranges,
  :cron_expression,
  :tag_specifications)
  SENSITIVE = []
  include Aws::Structure
end

#tag_specificationsArray<Types::TagSpecification>

The tags to apply to the event window.

Returns:



7326
7327
7328
7329
7330
7331
7332
7333
7334
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 7326

class CreateInstanceEventWindowRequest < Struct.new(
  :dry_run,
  :name,
  :time_ranges,
  :cron_expression,
  :tag_specifications)
  SENSITIVE = []
  include Aws::Structure
end

#time_rangesArray<Types::InstanceEventWindowTimeRangeRequest>

The time range for the event window. If you specify a time range, you can't specify a cron expression.



7326
7327
7328
7329
7330
7331
7332
7333
7334
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 7326

class CreateInstanceEventWindowRequest < Struct.new(
  :dry_run,
  :name,
  :time_ranges,
  :cron_expression,
  :tag_specifications)
  SENSITIVE = []
  include Aws::Structure
end