Amazonka.RBin.CreateRule

Creates a Recycle Bin retention rule. For more information, see Create Recycle Bin retention rules in the Amazon Elastic Compute Cloud User Guide.

Creating a Request

data CreateRule

See: newCreateRule smart constructor.

Constructors

CreateRule'

Fields

• description :: Maybe Text

  The retention rule description.

• lockConfiguration :: Maybe LockConfiguration

  Information about the retention rule lock configuration.

• resourceTags :: Maybe [ResourceTag]

  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.

• tags :: Maybe [Tag]

  Information about the tags to assign to the retention rule.

• retentionPeriod :: RetentionPeriod

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

• resourceType :: ResourceType

  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.

Instances

ToJSON CreateRule

Defined in Amazonka.RBin.CreateRule

Methods

toJSON :: CreateRule -> Value

toEncoding :: CreateRule -> Encoding

toJSONList :: [CreateRule] -> Value

toEncodingList :: [CreateRule] -> Encoding

ToHeaders CreateRule

Defined in Amazonka.RBin.CreateRule

Methods

toHeaders :: CreateRule -> [Header]

ToPath CreateRule

Defined in Amazonka.RBin.CreateRule

Methods

toPath :: CreateRule -> ByteString

ToQuery CreateRule

Defined in Amazonka.RBin.CreateRule

Methods

toQuery :: CreateRule -> QueryString

AWSRequest CreateRule

Defined in Amazonka.RBin.CreateRule

Associated Types

type AWSResponse CreateRule

Methods

request :: (Service -> Service) -> CreateRule -> Request CreateRule

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateRule -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateRule)))

Generic CreateRule

Defined in Amazonka.RBin.CreateRule

Associated Types

type Rep CreateRule :: Type -> Type

Methods

from :: CreateRule -> Rep CreateRule x

to :: Rep CreateRule x -> CreateRule

Read CreateRule

Defined in Amazonka.RBin.CreateRule

Methods

readsPrec :: Int -> ReadS CreateRule

readList :: ReadS [CreateRule]

readPrec :: ReadPrec CreateRule

readListPrec :: ReadPrec [CreateRule]

Show CreateRule

Defined in Amazonka.RBin.CreateRule

Methods

showsPrec :: Int -> CreateRule -> ShowS

show :: CreateRule -> String

showList :: [CreateRule] -> ShowS

NFData CreateRule

Defined in Amazonka.RBin.CreateRule

Methods

rnf :: CreateRule -> ()

Eq CreateRule

Defined in Amazonka.RBin.CreateRule

Methods

(==) :: CreateRule -> CreateRule -> Bool

(/=) :: CreateRule -> CreateRule -> Bool

Hashable CreateRule

Defined in Amazonka.RBin.CreateRule

Methods

hashWithSalt :: Int -> CreateRule -> Int

hash :: CreateRule -> Int

type AWSResponse CreateRule

Defined in Amazonka.RBin.CreateRule

type AWSResponse CreateRule = CreateRuleResponse

type Rep CreateRule

Defined in Amazonka.RBin.CreateRule

type Rep CreateRule = D1 ('MetaData "CreateRule" "Amazonka.RBin.CreateRule" "amazonka-rbin-2.0-683M7qr6PFTBsVsY3OL2az" 'False) (C1 ('MetaCons "CreateRule'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "lockConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LockConfiguration)) :*: S1 ('MetaSel ('Just "resourceTags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ResourceTag])))) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: (S1 ('MetaSel ('Just "retentionPeriod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 RetentionPeriod) :*: S1 ('MetaSel ('Just "resourceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ResourceType)))))

newCreateRule

Arguments

:: RetentionPeriod

CreateRule

-> ResourceType

CreateRule

-> CreateRule

Create a value of CreateRule with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateRule, createRule_description - The retention rule description.

CreateRule, createRule_lockConfiguration - Information about the retention rule lock configuration.

CreateRule, createRule_resourceTags - 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.

CreateRule, createRule_tags - Information about the tags to assign to the retention rule.

CreateRule, createRule_retentionPeriod - Information about the retention period for which the retention rule is to retain resources.

CreateRule, createRule_resourceType - 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.

Request Lenses

createRule_description :: Lens' CreateRule (Maybe Text)

The retention rule description.

createRule_lockConfiguration :: Lens' CreateRule (Maybe LockConfiguration)

Information about the retention rule lock configuration.

createRule_resourceTags :: Lens' CreateRule (Maybe [ResourceTag])

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.

createRule_tags :: Lens' CreateRule (Maybe [Tag])

Information about the tags to assign to the retention rule.

createRule_retentionPeriod :: Lens' CreateRule RetentionPeriod

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

createRule_resourceType :: Lens' CreateRule ResourceType

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.

Destructuring the Response

data CreateRuleResponse

See: newCreateRuleResponse smart constructor.

Constructors

CreateRuleResponse'

Fields

• description :: Maybe Text

  The retention rule description.

• identifier :: Maybe Text

  The unique ID of the retention rule.

• lockConfiguration :: Maybe LockConfiguration

  Information about the retention rule lock configuration.

• lockState :: Maybe LockState

  The lock state for the retention rule.

  • locked - The retention rule is locked and can't be modified or deleted.
  • pending_unlock - The retention rule has been unlocked but it is still within the unlock delay period. The retention rule can be modified or deleted only after the unlock delay period has expired.
  • unlocked - The retention rule is unlocked and it can be modified or deleted by any user with the required permissions.
  • null - The retention rule has never been locked. Once a retention rule has been locked, it can transition between the locked and unlocked states only; it can never transition back to null.
• resourceTags :: Maybe [ResourceTag]

  Information about the resource tags used to identify resources that are retained by the retention rule.

• resourceType :: Maybe ResourceType

  The resource type retained by the retention rule.

• retentionPeriod :: Maybe RetentionPeriod
• status :: Maybe RuleStatus

  The state of the retention rule. Only retention rules that are in the available state retain resources.

• tags :: Maybe [Tag]

  Information about the tags assigned to the retention rule.

• httpStatus :: Int

  The response's http status code.

Instances

Generic CreateRuleResponse

Defined in Amazonka.RBin.CreateRule

Associated Types

type Rep CreateRuleResponse :: Type -> Type

Methods

from :: CreateRuleResponse -> Rep CreateRuleResponse x

to :: Rep CreateRuleResponse x -> CreateRuleResponse

Read CreateRuleResponse

Defined in Amazonka.RBin.CreateRule

Methods

readsPrec :: Int -> ReadS CreateRuleResponse

readList :: ReadS [CreateRuleResponse]

readPrec :: ReadPrec CreateRuleResponse

readListPrec :: ReadPrec [CreateRuleResponse]

Show CreateRuleResponse

Defined in Amazonka.RBin.CreateRule

Methods

showsPrec :: Int -> CreateRuleResponse -> ShowS

show :: CreateRuleResponse -> String

showList :: [CreateRuleResponse] -> ShowS

NFData CreateRuleResponse

Defined in Amazonka.RBin.CreateRule

Methods

rnf :: CreateRuleResponse -> ()

Eq CreateRuleResponse

Defined in Amazonka.RBin.CreateRule

Methods

(==) :: CreateRuleResponse -> CreateRuleResponse -> Bool

(/=) :: CreateRuleResponse -> CreateRuleResponse -> Bool

type Rep CreateRuleResponse

Defined in Amazonka.RBin.CreateRule

type Rep CreateRuleResponse = D1 ('MetaData "CreateRuleResponse" "Amazonka.RBin.CreateRule" "amazonka-rbin-2.0-683M7qr6PFTBsVsY3OL2az" 'False) (C1 ('MetaCons "CreateRuleResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "identifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "lockConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LockConfiguration)) :*: (S1 ('MetaSel ('Just "lockState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LockState)) :*: S1 ('MetaSel ('Just "resourceTags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ResourceTag]))))) :*: ((S1 ('MetaSel ('Just "resourceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ResourceType)) :*: S1 ('MetaSel ('Just "retentionPeriod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RetentionPeriod))) :*: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RuleStatus)) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newCreateRuleResponse

Arguments

:: Int

$sel:httpStatus:CreateRuleResponse'

-> CreateRuleResponse

Create a value of CreateRuleResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateRule, createRuleResponse_description - The retention rule description.

CreateRuleResponse, createRuleResponse_identifier - The unique ID of the retention rule.

CreateRule, createRuleResponse_lockConfiguration - Information about the retention rule lock configuration.

CreateRuleResponse, createRuleResponse_lockState - The lock state for the retention rule.

• locked - The retention rule is locked and can't be modified or deleted.
• pending_unlock - The retention rule has been unlocked but it is still within the unlock delay period. The retention rule can be modified or deleted only after the unlock delay period has expired.
• unlocked - The retention rule is unlocked and it can be modified or deleted by any user with the required permissions.
• null - The retention rule has never been locked. Once a retention rule has been locked, it can transition between the locked and unlocked states only; it can never transition back to null.

CreateRule, createRuleResponse_resourceTags - Information about the resource tags used to identify resources that are retained by the retention rule.

CreateRule, createRuleResponse_resourceType - The resource type retained by the retention rule.

CreateRule, createRuleResponse_retentionPeriod - Undocumented member.

$sel:status:CreateRuleResponse', createRuleResponse_status - The state of the retention rule. Only retention rules that are in the available state retain resources.

CreateRule, createRuleResponse_tags - Information about the tags assigned to the retention rule.

$sel:httpStatus:CreateRuleResponse', createRuleResponse_httpStatus - The response's http status code.

Response Lenses

createRuleResponse_description :: Lens' CreateRuleResponse (Maybe Text)

The retention rule description.

createRuleResponse_identifier :: Lens' CreateRuleResponse (Maybe Text)

The unique ID of the retention rule.

createRuleResponse_lockConfiguration :: Lens' CreateRuleResponse (Maybe LockConfiguration)

Information about the retention rule lock configuration.

createRuleResponse_lockState :: Lens' CreateRuleResponse (Maybe LockState)

The lock state for the retention rule.

• locked - The retention rule is locked and can't be modified or deleted.
• pending_unlock - The retention rule has been unlocked but it is still within the unlock delay period. The retention rule can be modified or deleted only after the unlock delay period has expired.
• unlocked - The retention rule is unlocked and it can be modified or deleted by any user with the required permissions.
• null - The retention rule has never been locked. Once a retention rule has been locked, it can transition between the locked and unlocked states only; it can never transition back to null.

createRuleResponse_resourceTags :: Lens' CreateRuleResponse (Maybe [ResourceTag])

Information about the resource tags used to identify resources that are retained by the retention rule.

createRuleResponse_resourceType :: Lens' CreateRuleResponse (Maybe ResourceType)

The resource type retained by the retention rule.

createRuleResponse_retentionPeriod :: Lens' CreateRuleResponse (Maybe RetentionPeriod)

Undocumented member.

createRuleResponse_status :: Lens' CreateRuleResponse (Maybe RuleStatus)

The state of the retention rule. Only retention rules that are in the available state retain resources.

createRuleResponse_tags :: Lens' CreateRuleResponse (Maybe [Tag])

Information about the tags assigned to the retention rule.

createRuleResponse_httpStatus :: Lens' CreateRuleResponse Int

The response's http status code.