software.amazon.awscdk.services.mediapackage

Class CfnAsset

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.CfnAsset

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.915Z")
 @Stability(value=Stable)
public class CfnAsset
extends CfnResource
implements IInspectable

A CloudFormation `AWS::MediaPackage::Asset`.

Creates an asset to ingest VOD content.

After it's created, the asset starts ingesting content and generates playback URLs for the packaging configurations associated with it. When ingest is complete, downstream devices use the appropriate URL to request VOD content from AWS Elemental MediaPackage .

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.*;
 CfnAsset cfnAsset = CfnAsset.Builder.create(this, "MyCfnAsset")
         .id("id")
         .packagingGroupId("packagingGroupId")
         .sourceArn("sourceArn")
         .sourceRoleArn("sourceRoleArn")
         // the properties below are optional
         .resourceId("resourceId")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnAsset.Builder A fluent builder for CfnAsset.
static interface	CfnAsset.EgressEndpointProperty The playback endpoint for a packaging configuration on an asset.

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
	CfnAsset(software.constructs.Construct scope, String id, CfnAssetProps props) Create a new `AWS::MediaPackage::Asset`.
protected	CfnAsset(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnAsset(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrArn() The Amazon Resource Name (ARN) for the asset.
String	getAttrCreatedAt() The time that the asset was initially submitted for ingest.
IResolvable	getAttrEgressEndpoints()
protected Map<String,Object>	getCfnProperties()
String	getId() Unique identifier that you assign to the asset.
String	getPackagingGroupId() The ID of the packaging group associated with this asset.
String	getResourceId() Unique identifier for this asset, as it's configured in the key provider service.
String	getSourceArn() The ARN for the source content in Amazon S3.
String	getSourceRoleArn() The ARN for the IAM role that provides AWS Elemental MediaPackage access to the Amazon S3 bucket where the source content is stored.
TagManager	getTags() The tags to assign to the asset.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setId(String value) Unique identifier that you assign to the asset.
void	setPackagingGroupId(String value) The ID of the packaging group associated with this asset.
void	setResourceId(String value) Unique identifier for this asset, as it's configured in the key provider service.
void	setSourceArn(String value) The ARN for the source content in Amazon S3.
void	setSourceRoleArn(String value) The ARN for the IAM role that provides AWS Elemental MediaPackage access to the Amazon S3 bucket where the source content is stored.

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

CfnAsset

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

CfnAsset

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

CfnAsset

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

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

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 asset.

You can get this from the response to any request to the asset.

getAttrCreatedAt

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

The time that the asset was initially submitted for ingest.

getAttrEgressEndpoints

@Stability(value=Stable)
 @NotNull
public IResolvable getAttrEgressEndpoints()

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 asset.

getId

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

Unique identifier that you assign to the asset.

setId

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

Unique identifier that you assign to the asset.

getPackagingGroupId

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

The ID of the packaging group associated with this asset.

setPackagingGroupId

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

The ID of the packaging group associated with this asset.

getSourceArn

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

The ARN for the source content in Amazon S3.

setSourceArn

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

The ARN for the source content in Amazon S3.

getSourceRoleArn

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

The ARN for the IAM role that provides AWS Elemental MediaPackage access to the Amazon S3 bucket where the source content is stored.

Valid format: arn:aws:iam::{accountID}:role/{name}

setSourceRoleArn

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

The ARN for the IAM role that provides AWS Elemental MediaPackage access to the Amazon S3 bucket where the source content is stored.

Valid format: arn:aws:iam::{accountID}:role/{name}

getResourceId

@Stability(value=Stable)
 @Nullable
public String getResourceId()

Unique identifier for this asset, as it's configured in the key provider service.

setResourceId

@Stability(value=Stable)
public void setResourceId(@Nullable
                                                   String value)

Unique identifier for this asset, as it's configured in the key provider service.