Class: Aws::RecycleBin::Types::CreateRuleRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-recyclebin/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#description ⇒ String

The retention rule description.

Returns:

  • (String) 


86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/aws-sdk-recyclebin/types.rb', line 86

class CreateRuleRequest < Struct.new(
  :retention_period,
  :description,
  :tags,
  :resource_type,
  :resource_tags,
  :lock_configuration,
  :exclude_resource_tags)
  SENSITIVE = []
  include Aws::Structure
end

#exclude_resource_tags ⇒ Array<Types::ResourceTag>

[Region-level retention rules only] Specifies the exclusion tags to use to identify resources that are to be excluded, or ignored, by a Region-level retention rule. Resources that have any of these tags are not retained by the retention rule upon deletion.

You can’t specify exclusion tags for tag-level retention rules.

Returns:



86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/aws-sdk-recyclebin/types.rb', line 86

class CreateRuleRequest < Struct.new(
  :retention_period,
  :description,
  :tags,
  :resource_type,
  :resource_tags,
  :lock_configuration,
  :exclude_resource_tags)
  SENSITIVE = []
  include Aws::Structure
end

#lock_configuration ⇒ Types::LockConfiguration

Information about the retention rule lock configuration.

Returns:



86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/aws-sdk-recyclebin/types.rb', line 86

class CreateRuleRequest < Struct.new(
  :retention_period,
  :description,
  :tags,
  :resource_type,
  :resource_tags,
  :lock_configuration,
  :exclude_resource_tags)
  SENSITIVE = []
  include Aws::Structure
end

#resource_tags ⇒ Array<Types::ResourceTag>

[Tag-level retention rules only] Specifies the resource tags to use to identify resources that are to be retained by a tag-level retention rule. For tag-level retention rules, only deleted resources, of the specified resource type, that have one or more of the specified tag key and value pairs are retained. If a resource is deleted, but it does not have any of the specified tag key and value pairs, it is immediately deleted without being retained by the retention rule.

You can add the same tag key and value pair to a maximum or five retention rules.

To create a Region-level retention rule, omit this parameter. A Region-level retention rule does not have any resource tags specified. It retains all deleted resources of the specified resource type in the Region in which the rule is created, even if the resources are not tagged.

Returns:



86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/aws-sdk-recyclebin/types.rb', line 86

class CreateRuleRequest < Struct.new(
  :retention_period,
  :description,
  :tags,
  :resource_type,
  :resource_tags,
  :lock_configuration,
  :exclude_resource_tags)
  SENSITIVE = []
  include Aws::Structure
end

#resource_type ⇒ String

The resource type to be retained by the retention rule. Currently, only Amazon EBS snapshots and EBS-backed AMIs are supported. To retain snapshots, specify ‘EBS_SNAPSHOT`. To retain EBS-backed AMIs, specify `EC2_IMAGE`.

Returns:

  • (String) 


86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/aws-sdk-recyclebin/types.rb', line 86

class CreateRuleRequest < Struct.new(
  :retention_period,
  :description,
  :tags,
  :resource_type,
  :resource_tags,
  :lock_configuration,
  :exclude_resource_tags)
  SENSITIVE = []
  include Aws::Structure
end

#retention_period ⇒ Types::RetentionPeriod

Information about the retention period for which the retention rule is to retain resources.

Returns:



86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/aws-sdk-recyclebin/types.rb', line 86

class CreateRuleRequest < Struct.new(
  :retention_period,
  :description,
  :tags,
  :resource_type,
  :resource_tags,
  :lock_configuration,
  :exclude_resource_tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

Information about the tags to assign to the retention rule.

Returns:



86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/aws-sdk-recyclebin/types.rb', line 86

class CreateRuleRequest < Struct.new(
  :retention_period,
  :description,
  :tags,
  :resource_type,
  :resource_tags,
  :lock_configuration,
  :exclude_resource_tags)
  SENSITIVE = []
  include Aws::Structure
end