software.amazon.awscdk.services.mediapackage

Class CfnPackagingGroup

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.mediapackage.CfnPackagingGroup

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:40.948Z")
 @Stability(value=Stable)
public class CfnPackagingGroup
extends CfnResource
implements IInspectable

A CloudFormation `AWS::MediaPackage::PackagingGroup`.

Creates a packaging group.

The packaging group holds one or more packaging configurations. When you create an asset, you specify the packaging group associated with the asset. The asset has playback endpoints for each packaging configuration within the group.

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.mediapackage.*;
 CfnPackagingGroup cfnPackagingGroup = CfnPackagingGroup.Builder.create(this, "MyCfnPackagingGroup")
         .id("id")
         // the properties below are optional
         .authorization(AuthorizationProperty.builder()
                 .cdnIdentifierSecret("cdnIdentifierSecret")
                 .secretsRoleArn("secretsRoleArn")
                 .build())
         .egressAccessLogs(LogConfigurationProperty.builder()
                 .logGroupName("logGroupName")
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnPackagingGroup.AuthorizationProperty Parameters for enabling CDN authorization.
static class	CfnPackagingGroup.Builder A fluent builder for CfnPackagingGroup.
static interface	CfnPackagingGroup.LogConfigurationProperty Sets a custom Amazon CloudWatch log group name for egress logs.

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

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

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

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnPackagingGroup(software.constructs.Construct scope, String id, CfnPackagingGroupProps props) Create a new `AWS::MediaPackage::PackagingGroup`.
protected	CfnPackagingGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnPackagingGroup(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrArn() The Amazon Resource Name (ARN) for the packaging group.
String	getAttrDomainName() The fully qualified domain name for the assets in the PackagingGroup.
Object	getAuthorization() Parameters for CDN authorization.
protected Map<String,Object>	getCfnProperties()
Object	getEgressAccessLogs() The configuration parameters for egress access logging.
String	getId() Unique identifier that you assign to the packaging group.
TagManager	getTags() The tags to assign to the packaging group.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAuthorization(CfnPackagingGroup.AuthorizationProperty value) Parameters for CDN authorization.
void	setAuthorization(IResolvable value) Parameters for CDN authorization.
void	setEgressAccessLogs(CfnPackagingGroup.LogConfigurationProperty value) The configuration parameters for egress access logging.
void	setEgressAccessLogs(IResolvable value) The configuration parameters for egress access logging.
void	setId(String value) Unique identifier that you assign to the packaging group.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, 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.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnPackagingGroup

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

CfnPackagingGroup

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

CfnPackagingGroup

@Stability(value=Stable)
public CfnPackagingGroup(@NotNull
                                                  software.constructs.Construct scope,
                                                  @NotNull
                                                  String id,
                                                  @NotNull
                                                  CfnPackagingGroupProps props)

Create a new `AWS::MediaPackage::PackagingGroup`.

Parameters:

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

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=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(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(value=Stable)
 @NotNull
public String getAttrArn()

The Amazon Resource Name (ARN) for the packaging group.

You can get this from the response to any request to the packaging group.

getAttrDomainName

@Stability(value=Stable)
 @NotNull
public String getAttrDomainName()

The fully qualified domain name for the assets in the PackagingGroup.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

The tags to assign to the packaging group.

getId

@Stability(value=Stable)
 @NotNull
public String getId()

Unique identifier that you assign to the packaging group.

setId

@Stability(value=Stable)
public void setId(@NotNull
                                           String value)

Unique identifier that you assign to the packaging group.

getAuthorization

@Stability(value=Stable)
 @Nullable
public Object getAuthorization()

Parameters for CDN authorization.

setAuthorization

@Stability(value=Stable)
public void setAuthorization(@Nullable
                                                      CfnPackagingGroup.AuthorizationProperty value)

Parameters for CDN authorization.

setAuthorization

@Stability(value=Stable)
public void setAuthorization(@Nullable
                                                      IResolvable value)

Parameters for CDN authorization.

getEgressAccessLogs

@Stability(value=Stable)
 @Nullable
public Object getEgressAccessLogs()

The configuration parameters for egress access logging.

setEgressAccessLogs

@Stability(value=Stable)
public void setEgressAccessLogs(@Nullable
                                                         CfnPackagingGroup.LogConfigurationProperty value)

The configuration parameters for egress access logging.

setEgressAccessLogs

@Stability(value=Stable)
public void setEgressAccessLogs(@Nullable
                                                         IResolvable value)

The configuration parameters for egress access logging.