queue_inline_policies

Creates, updates, deletes or gets a queue_inline_policy resource or lists queue_inline_policies in a region

Overview

Name	queue_inline_policies
Type	Resource
Description	Schema for SQS QueueInlinePolicy
Id	awscc.sqs.queue_inline_policies

Fields

Name	Datatype	Description
policy_document	object	A policy document that contains permissions to add to the specified SQS queue
queue	string	The URL of the SQS queue.
region	string	AWS region.

For more information, see AWS::SQS::QueueInlinePolicy.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	PolicyDocument, Queue, region
delete_resource	DELETE	Identifier, region
update_resource	UPDATE	Identifier, PatchDocument, region
get_resource	SELECT	Identifier, region

SELECT examples

Gets all properties from an individual queue_inline_policy.

SELECT
  region,
  policy_document,
  queue
FROM awscc.sqs.queue_inline_policies
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ queue }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.sqs.queue_inline_policies (
  PolicyDocument,
  Queue,
  region
)
SELECT
  '{{ policy_document }}',
  '{{ queue }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.sqs.queue_inline_policies (
  PolicyDocument,
  Queue,
  region
)
SELECT
  '{{ policy_document }}',
  '{{ queue }}',
  '{{ 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: queue_inline_policy
  props:
    - name: policy_document
      value: {}
    - name: queue
      value: '{{ queue }}'

UPDATE example

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

/*+ update */
UPDATE awscc.sqs.queue_inline_policies
SET PatchDocument = string('{{ {
    "PolicyDocument": policy_document
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ queue }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.sqs.queue_inline_policies
WHERE
  Identifier = '{{ queue }}' 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 queue_inline_policies resource, the following permissions are required:

Create

sqs:SetQueueAttributes,
sqs:GetQueueAttributes,
sqs:GetQueueUrl

Read

sqs:GetQueueAttributes,
sqs:GetQueueUrl

Delete

sqs:SetQueueAttributes,
sqs:GetQueueAttributes

Update

sqs:SetQueueAttributes,
sqs:GetQueueAttributes,
sqs:GetQueueUrl