Class: Aws::DLM::Types::CreateRule

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

Overview

Note:

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

{
  location: "CLOUD", # accepts CLOUD, OUTPOST_LOCAL
  interval: 1,
  interval_unit: "HOURS", # accepts HOURS
  times: ["Time"],
  cron_expression: "CronExpression",
}

Specifies when to create snapshots of EBS volumes.

You must specify either a Cron expression or an interval, interval unit, and start time. You cannot specify both.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#cron_expressionString

The schedule, as a Cron expression. The schedule interval must be between 1 hour and 1 year. For more information, see Cron expressions in the Amazon CloudWatch User Guide.

Returns:

  • (String)


278
279
280
281
282
283
284
285
286
# File 'gems/aws-sdk-dlm/lib/aws-sdk-dlm/types.rb', line 278

class CreateRule < Struct.new(
  :location,
  :interval,
  :interval_unit,
  :times,
  :cron_expression)
  SENSITIVE = []
  include Aws::Structure
end

#intervalInteger

The interval between snapshots. The supported values are 1, 2, 3, 4, 6, 8, 12, and 24.

Returns:

  • (Integer)


278
279
280
281
282
283
284
285
286
# File 'gems/aws-sdk-dlm/lib/aws-sdk-dlm/types.rb', line 278

class CreateRule < Struct.new(
  :location,
  :interval,
  :interval_unit,
  :times,
  :cron_expression)
  SENSITIVE = []
  include Aws::Structure
end

#interval_unitString

The interval unit.

Returns:

  • (String)


278
279
280
281
282
283
284
285
286
# File 'gems/aws-sdk-dlm/lib/aws-sdk-dlm/types.rb', line 278

class CreateRule < Struct.new(
  :location,
  :interval,
  :interval_unit,
  :times,
  :cron_expression)
  SENSITIVE = []
  include Aws::Structure
end

#locationString

Specifies the destination for snapshots created by the policy. To create snapshots in the same Region as the source resource, specify CLOUD. To create snapshots on the same Outpost as the source resource, specify OUTPOST_LOCAL. If you omit this parameter, CLOUD is used by default.

If the policy targets resources in an Amazon Web Services Region, then you must create snapshots in the same Region as the source resource.

If the policy targets resources on an Outpost, then you can create snapshots on the same Outpost as the source resource, or in the Region of that Outpost.

Returns:

  • (String)


278
279
280
281
282
283
284
285
286
# File 'gems/aws-sdk-dlm/lib/aws-sdk-dlm/types.rb', line 278

class CreateRule < Struct.new(
  :location,
  :interval,
  :interval_unit,
  :times,
  :cron_expression)
  SENSITIVE = []
  include Aws::Structure
end

#timesArray<String>

The time, in UTC, to start the operation. The supported format is hh:mm.

The operation occurs within a one-hour window following the specified time. If you do not specify a time, Amazon DLM selects a time within the next 24 hours.

Returns:

  • (Array<String>)


278
279
280
281
282
283
284
285
286
# File 'gems/aws-sdk-dlm/lib/aws-sdk-dlm/types.rb', line 278

class CreateRule < Struct.new(
  :location,
  :interval,
  :interval_unit,
  :times,
  :cron_expression)
  SENSITIVE = []
  include Aws::Structure
end