rules

Creates, updates, deletes or gets a rule resource or lists rules in a region

Overview

Name	rules
Type	Resource
Description	Resource Type definition for AWS::Rbin::Rule
Id	awscc.rbin.rules

Fields

get (all properties)

Name	Datatype	Description
arn	string	Rule Arn is unique for each rule.
identifier	string	The unique ID of the retention rule.
description	string	The description of the retention rule.
▶resource_tags	array	Information about the resource tags used to identify resources that are retained by the retention rule.
exclude_resource_tags	array	Information about the exclude resource tags used to identify resources that are excluded by the retention rule.
resource_type	string	The resource type retained by the retention rule.
▶tags	array	Information about the tags assigned to the retention rule.
▶retention_period	object	Information about the retention period for which the retention rule is to retain resources.
status	string	The state of the retention rule. Only retention rules that are in the available state retain resources.
▶lock_configuration	object	Information about the retention rule lock configuration.
lock_state	string	The lock state for the retention rule.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
arn	string	Rule Arn is unique for each rule.
region	string	AWS region.

For more information, see AWS::Rbin::Rule.

Methods

Name	Resource	Accessible by	Required Params
create_resource	rules	INSERT	RetentionPeriod, ResourceType, region
delete_resource	rules	DELETE	Identifier, region
update_resource	rules	UPDATE	Identifier, PatchDocument, region
list_resources	rules_list_only	SELECT	region
get_resource	rules	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual rule.

SELECT
  region,
  arn,
  identifier,
  description,
  resource_tags,
  exclude_resource_tags,
  resource_type,
  tags,
  retention_period,
  status,
  lock_configuration,
  lock_state
FROM awscc.rbin.rules
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}';

list (identifiers only)

Lists all rules in a region.

SELECT
  region,
  arn
FROM awscc.rbin.rules_list_only
WHERE
  region = '{{ region }}';

INSERT example

Use the following StackQL query and manifest file to create a new rule resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.rbin.rules (
  ResourceType,
  RetentionPeriod,
  region
)
SELECT
  '{{ resource_type }}',
  '{{ retention_period }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.rbin.rules (
  Description,
  ResourceTags,
  ExcludeResourceTags,
  ResourceType,
  Tags,
  RetentionPeriod,
  Status,
  LockConfiguration,
  region
)
SELECT
  '{{ description }}',
  '{{ resource_tags }}',
  '{{ exclude_resource_tags }}',
  '{{ resource_type }}',
  '{{ tags }}',
  '{{ retention_period }}',
  '{{ status }}',
  '{{ lock_configuration }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: rule
  props:
    - name: description
      value: '{{ description }}'
    - name: resource_tags
      value:
        - resource_tag_key: '{{ resource_tag_key }}'
          resource_tag_value: '{{ resource_tag_value }}'
    - name: exclude_resource_tags
      value:
        - null
    - name: resource_type
      value: '{{ resource_type }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'
    - name: retention_period
      value:
        retention_period_value: '{{ retention_period_value }}'
        retention_period_unit: '{{ retention_period_unit }}'
    - name: status
      value: '{{ status }}'
    - name: lock_configuration
      value:
        unlock_delay_value: '{{ unlock_delay_value }}'
        unlock_delay_unit: '{{ unlock_delay_unit }}'

UPDATE example

Use the following StackQL query and manifest file to update a rule resource, using stack-deploy.

/*+ update */
UPDATE awscc.rbin.rules
SET PatchDocument = string('{{ {
    "Description": description,
    "ResourceTags": resource_tags,
    "ExcludeResourceTags": exclude_resource_tags,
    "Tags": tags,
    "RetentionPeriod": retention_period,
    "Status": status,
    "LockConfiguration": lock_configuration
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.rbin.rules
WHERE
  Identifier = '{{ arn }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

Permissions

To operate on the rules resource, the following permissions are required:

Create

rbin:CreateRule,
rbin:GetRule,
rbin:LockRule,
rbin:TagResource,
iam:PassRole

Read

rbin:GetRule,
rbin:ListTagsForResource,
iam:PassRole

Update

rbin:GetRule,
rbin:UpdateRule,
rbin:LockRule,
rbin:UnlockRule,
rbin:TagResource,
rbin:UntagResource,
rbin:ListTagsForResource,
iam:PassRole

Delete

rbin:GetRule,
rbin:DeleteRule,
iam:PassRole

List

rbin:ListRules,
rbin:ListTagsForResource,
iam:PassRole