Package software.amazon.awscdk.services.mediapackage

Class CfnAsset

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.mediapackage.CfnAsset
All Implemented Interfaces:
software.amazon.awscdk.core.IConstruct, software.amazon.awscdk.core.IDependable, software.amazon.awscdk.core.IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-05-31T18:43:33.708Z") @Stability(Stable) public class CfnAsset extends software.amazon.awscdk.core.CfnResource implements software.amazon.awscdk.core.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
         .egressEndpoints(List.of(EgressEndpointProperty.builder()
                 .packagingConfigurationId("packagingConfigurationId")
                 .url("url")
                 .build()))
         .resourceId("resourceId")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final 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.core.IConstruct

    software.amazon.awscdk.core.IConstruct.Jsii$Default

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

    software.constructs.IConstruct.Jsii$Default

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

    software.amazon.awscdk.core.IInspectable.Jsii$Default, software.amazon.awscdk.core.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
     
    CfnAsset(software.amazon.awscdk.core.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
    Description
    String
    getAttrArn()
    The Amazon Resource Name (ARN) for the asset.
    String
    getAttrCreatedAt()
    The date and time that the asset was initially submitted for ingest.
    protected Map<String,Object>
    getCfnProperties()
     
    Object
    getEgressEndpoints()
    List of playback endpoints that are available for this asset.
    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.
    software.amazon.awscdk.core.TagManager
    getTags()
    The tags to assign to the asset.
    void
    inspect(software.amazon.awscdk.core.TreeInspector inspector)
    Examines the CloudFormation resource and discloses attributes.
    protected Map<String,Object>
    renderProperties(Map<String,Object> props)
     
    void
    setEgressEndpoints(List<Object> value)
    List of playback endpoints that are available for this asset.
    void
    setEgressEndpoints(software.amazon.awscdk.core.IResolvable value)
    List of playback endpoints that are available for this asset.
    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.core.CfnResource

    addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

    Methods inherited from class software.amazon.awscdk.core.CfnRefElement

    getRef

    Methods inherited from class software.amazon.awscdk.core.CfnElement

    getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

    Methods inherited from class software.amazon.awscdk.core.Construct

    getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

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

    • CfnAsset

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

    • CfnAsset

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

    • CfnAsset

      @Stability(Stable) public CfnAsset(@NotNull software.amazon.awscdk.core.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 Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull software.amazon.awscdk.core.TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface software.amazon.awscdk.core.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 software.amazon.awscdk.core.CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(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(Stable) @NotNull public String getAttrCreatedAt()
      The date and time that the asset was initially submitted for ingest.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class software.amazon.awscdk.core.CfnResource

    • getTags

      @Stability(Stable) @NotNull public software.amazon.awscdk.core.TagManager getTags()
      The tags to assign to the asset.

    • getId

      @Stability(Stable) @NotNull public String getId()
      Unique identifier that you assign to the asset.

    • setId

      @Stability(Stable) public void setId(@NotNull String value)
      Unique identifier that you assign to the asset.

    • getPackagingGroupId

      @Stability(Stable) @NotNull public String getPackagingGroupId()
      The ID of the packaging group associated with this asset.

    • setPackagingGroupId

      @Stability(Stable) public void setPackagingGroupId(@NotNull String value)
      The ID of the packaging group associated with this asset.

    • getSourceArn

      @Stability(Stable) @NotNull public String getSourceArn()
      The ARN for the source content in Amazon S3.

    • setSourceArn

      @Stability(Stable) public void setSourceArn(@NotNull String value)
      The ARN for the source content in Amazon S3.

    • getSourceRoleArn

      @Stability(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(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}

    • getEgressEndpoints

      @Stability(Stable) @Nullable public Object getEgressEndpoints()
      List of playback endpoints that are available for this asset.

    • setEgressEndpoints

      @Stability(Stable) public void setEgressEndpoints(@Nullable software.amazon.awscdk.core.IResolvable value)
      List of playback endpoints that are available for this asset.

    • setEgressEndpoints

      @Stability(Stable) public void setEgressEndpoints(@Nullable List<Object> value)
      List of playback endpoints that are available for this asset.

    • getResourceId

      @Stability(Stable) @Nullable public String getResourceId()
      Unique identifier for this asset, as it's configured in the key provider service.

    • setResourceId

      @Stability(Stable) public void setResourceId(@Nullable String value)
      Unique identifier for this asset, as it's configured in the key provider service.