resource_policies

Creates, updates, deletes or gets a resource_policy resource or lists resource_policies in a region

Overview

Name	resource_policies
Type	Resource
Description	Resource Type definition for AWS::Kinesis::ResourcePolicy
Id	awscc.kinesis.resource_policies

Fields

Name	Datatype	Description
resource_arn	string	The ARN of the AWS Kinesis resource to which the policy applies.
resource_policy	object	A policy document containing permissions to add to the specified resource. In IAM, you must provide policy documents in JSON format. However, in CloudFormation you can provide the policy in JSON or YAML format because CloudFormation converts YAML to JSON before submitting it to IAM.
region	string	AWS region.

For more information, see AWS::Kinesis::ResourcePolicy.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	ResourceArn, ResourcePolicy, 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 resource_policy.

SELECT
  region,
  resource_arn,
  resource_policy
FROM awscc.kinesis.resource_policies
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ resource_arn }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.kinesis.resource_policies (
  ResourceArn,
  ResourcePolicy,
  region
)
SELECT
  '{{ resource_arn }}',
  '{{ resource_policy }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.kinesis.resource_policies (
  ResourceArn,
  ResourcePolicy,
  region
)
SELECT
  '{{ resource_arn }}',
  '{{ resource_policy }}',
  '{{ 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: resource_policy
  props:
    - name: resource_arn
      value: '{{ resource_arn }}'
    - name: resource_policy
      value: {}

UPDATE example

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

/*+ update */
UPDATE awscc.kinesis.resource_policies
SET PatchDocument = string('{{ {
    "ResourcePolicy": resource_policy
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ resource_arn }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

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

Create

kinesis:GetResourcePolicy,
kinesis:PutResourcePolicy

Read

kinesis:GetResourcePolicy

Update

kinesis:PutResourcePolicy,
kinesis:GetResourcePolicy

Delete

kinesis:DeleteResourcePolicy,
kinesis:GetResourcePolicy