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:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:00.273Z") @Stability(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
         .egressEndpoints(List.of(EgressEndpointProperty.builder()
                 .packagingConfigurationId("packagingConfigurationId")
                 .url("url")
                 .build()))
         .resourceId("resourceId")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

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

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

    • getTags

      @Stability(Stable) @NotNull public 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 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.