ChannelPolicy

class aws_cdk.aws_mediapackagev2_alpha.ChannelPolicy(scope, id, *, channel, policy_document=None)

Bases: Resource

(experimental) The channel policy for an AWS Elemental MediaPackage V2 channel.

Policies define the operations that are allowed on this resource.

You almost never need to define this construct directly.

All AWS resources that support resource policies have a method called addToResourcePolicy(), which will automatically create a new resource policy if one doesn’t exist yet, otherwise it will add to the existing policy.

The channel policy method is implemented differently than addToResourcePolicy() as ChannelPolicy creates a new policy without knowing one earlier existed. This will cause a resource conflict if both are invoked (or even multiple channel policies are defined), so care is to be taken to ensure only 1 channel policy is created per channel.

Hence it’s strongly recommended to use addToResourcePolicy().

Stability:: experimental
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_mediapackagev2_alpha as mediapackagev2_alpha
from aws_cdk import aws_iam as iam

# channel: mediapackagev2_alpha.Channel
# policy_document: iam.PolicyDocument

channel_policy = mediapackagev2_alpha.ChannelPolicy(self, "MyChannelPolicy",
    channel=channel,

    # the properties below are optional
    policy_document=policy_document
)

Parameters:

scope (Construct)
id (str)
channel (IChannel) – (experimental) Channel to apply the Channel Policy to.
policy_document (Optional[PolicyDocument]) – (experimental) Initial policy document to apply. Default: - empty policy document

Stability:

experimental

Methods

apply_removal_policy(policy)

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters:: policy (RemovalPolicy)
Return type:: None

to_string()

Returns a string representation of this construct.

Return type:: str

with_(*mixins)

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:: mixins (IMixin)
Return type:: IConstruct

Attributes

PROPERTY_INJECTION_ID = '@aws-cdk.aws-mediapackagev2-alpha.ChannelPolicy'

document

(experimental) A policy document containing permissions to add to the specified channel.

Stability:: experimental

env

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

node: The tree node.

stack: The stack in which this resource is defined.

Static Methods

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Construct.

classmethod is_owned_resource(construct)

Returns true if the construct was created by CDK, and false otherwise.

Parameters:: construct (IConstruct)
Return type:: bool

classmethod is_resource(construct)

Check whether the given construct is a Resource.

Parameters:: construct (IConstruct)
Return type:: bool