Package software.amazon.awscdk.services.mediapackagev2

Class CfnChannelPolicy

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.mediapackagev2.CfnChannelPolicy

All Implemented Interfaces:

IEnvironmentAware, IInspectable, IChannelPolicyRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)",
           date="2025-11-10T13:40:09.928Z")
@Stability(Stable)
public class CfnChannelPolicy
extends CfnResource
implements IInspectable, IChannelPolicyRef

Specifies the configuration parameters of a MediaPackage V2 channel policy.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.mediapackagev2.*;
 Object policy;
 CfnChannelPolicy cfnChannelPolicy = CfnChannelPolicy.Builder.create(this, "MyCfnChannelPolicy")
         .channelGroupName("channelGroupName")
         .channelName("channelName")
         .policy(policy)
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-channelpolicy.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnChannelPolicy.Builder	A fluent builder for CfnChannelPolicy.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.mediapackagev2.IChannelPolicyRef

IChannelPolicyRef.Jsii$Default, IChannelPolicyRef.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnChannelPolicy(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnChannelPolicy(software.amazon.jsii.JsiiObjectRef objRef)
	CfnChannelPolicy(software.constructs.Construct scope, String id, CfnChannelPolicyProps props)

Method Summary

Modifier and Type	Method	Description
protected Map<String,Object>	getCfnProperties()
String	getChannelGroupName()	The name of the channel group associated with the channel policy.
String	getChannelName()	The name of the channel associated with the channel policy.
ChannelPolicyReference	getChannelPolicyRef()	A reference to a ChannelPolicy resource.
Object	getPolicy()	The policy associated with the channel.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setChannelGroupName(String value)	The name of the channel group associated with the channel policy.
void	setChannelName(String value)	The name of the channel associated with the channel policy.
void	setPolicy(Object value)	The policy associated with the channel.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getEnv, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.IEnvironmentAware

getEnv

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnChannelPolicy

protected CfnChannelPolicy(software.amazon.jsii.JsiiObjectRef objRef)

CfnChannelPolicy

protected CfnChannelPolicy(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnChannelPolicy

@Stability(Stable)
public CfnChannelPolicy(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnChannelPolicyProps props)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getChannelPolicyRef

@Stability(Stable)
@NotNull
public ChannelPolicyReference getChannelPolicyRef()

A reference to a ChannelPolicy resource.

Specified by:

getChannelPolicyRef in interface IChannelPolicyRef

getChannelGroupName

@Stability(Stable)
@NotNull
public String getChannelGroupName()

The name of the channel group associated with the channel policy.

setChannelGroupName

@Stability(Stable)
public void setChannelGroupName(@NotNull
 String value)

The name of the channel group associated with the channel policy.

getChannelName

@Stability(Stable)
@NotNull
public String getChannelName()

The name of the channel associated with the channel policy.

setChannelName

@Stability(Stable)
public void setChannelName(@NotNull
 String value)

The name of the channel associated with the channel policy.

getPolicy

@Stability(Stable)
@NotNull
public Object getPolicy()

The policy associated with the channel.

setPolicy

@Stability(Stable)
public void setPolicy(@NotNull
 Object value)

The policy associated with the channel.