AWS::SQS::QueuePolicy¶

The AWS::SQS::QueuePolicy type applies a policy to SQS queues.

Generated by cfn-typegen --out cfn_types AWS::SQS::QueuePolicy into cfn_types/sqs.py:

# Generated by cfn-typegen from the CloudFormation registry schemas. Do not edit.
# fmt: off
# ruff: noqa
"""AWS::SQS resources."""

from collections.abc import Mapping
from typing import Any, Literal, Unpack
from typing_extensions import TypedDict
from cfn_typed.base import DeletionPolicy, DependsOn, ResourceAttrs, UpdateReplacePolicy, build
from cfn_typed.intrinsics import Expr


CONSTRAINTS:dict[str,Any]={
}


ATTRIBUTES:dict[str,Any]={"AWS::SQS::QueuePolicy":["Id"]}


RULES:dict[str,Any]={}

Nested types (3)

These are defined above the properties in the generated module.

class QueuePolicyProps(TypedDict, closed=True):
    'The ``AWS::SQS::QueuePolicy`` type applies a policy to SQS queues.'
    PolicyDocument: Expr[Mapping[str, Any]] | Expr[str]
    'A policy document that contains the permissions for the specified SQS queues.'
    Queues: Expr[list[Expr[str]]]
    'The URLs of the queues to which you want to add the policy.'


class QueuePolicy(ResourceAttrs):
    'The ``AWS::SQS::QueuePolicy`` type applies a policy to SQS queues.'
    Type: Literal['AWS::SQS::QueuePolicy']
    Properties: QueuePolicyProps


def queue_policy(
    *,
    depends_on: DependsOn | None = None,
    deletion_policy: DeletionPolicy | None = None,
    update_replace_policy: UpdateReplacePolicy | None = None,
    condition: str | None = None,
    metadata: dict[str, Any] | None = None,
    **props: Unpack[QueuePolicyProps],
) -> QueuePolicy:
    return build('AWS::SQS::QueuePolicy', props, depends_on, deletion_policy, update_replace_policy, condition, metadata)

Attributes¶

Read-only values for get_att(logical_id, attribute). They are not accepted as inputs.

Id