aws-cdk-lib.aws_mediapackage.CfnOriginEndpoint

CfnOriginEndpoint L1 construct

Create an endpoint on an AWS Elemental MediaPackage channel.

An endpoint represents a single delivery point of a channel, and defines content output handling through various components, such as packaging protocols, DRM and encryption integration, and more.

After it's created, an endpoint provides a fixed public URL. This URL remains the same throughout the lifetime of the endpoint, regardless of any failures or upgrades that might occur. Integrate the URL with a downstream CDN (such as Amazon CloudFront) or playback device.

Construct›CfnElement›CfnRefElement›CfnResource›CfnOriginEndpoint

implements

• IInspectable,
• ITaggable,
• IEnvironmentAware,
• IOriginEndpointRef,
• 2 more

  • IConstruct,
  • IDependable

CloudFormation

AWS::MediaPackage::OriginEndpoint

Source

Generated code

Type last changed

v2.252.0 · 30 Apr 2026

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_mediapackage as mediapackage } from 'aws-cdk-lib';
const cfnOriginEndpoint = new mediapackage.CfnOriginEndpoint(this, 'MyCfnOriginEndpoint', {
  channelId: 'channelId',
  id: 'id',

  // the properties below are optional
  authorization: {
    cdnIdentifierSecret: 'cdnIdentifierSecret',
    secretsRoleArn: 'secretsRoleArn',
  },
  cmafPackage: {
    encryption: {
      spekeKeyProvider: {
        resourceId: 'resourceId',
        roleArn: 'roleArn',
        systemIds: ['systemIds'],
        url: 'url',

        // the properties below are optional
        certificateArn: 'certificateArn',
        encryptionContractConfiguration: {
          presetSpeke20Audio: 'presetSpeke20Audio',
          presetSpeke20Video: 'presetSpeke20Video',
        },
      },

      // the properties below are optional
      constantInitializationVector: 'constantInitializationVector',
      encryptionMethod: 'encryptionMethod',
      keyRotationIntervalSeconds: 123,
    },
    hlsManifests: [{
      id: 'id',

      // the properties below are optional
      adMarkers: 'adMarkers',
      adsOnDeliveryRestrictions: 'adsOnDeliveryRestrictions',
      adTriggers: ['adTriggers'],
      includeIframeOnlyStream: false,
      manifestName: 'manifestName',
      playlistType: 'playlistType',
      playlistWindowSeconds: 123,
      programDateTimeIntervalSeconds: 123,
      url: 'url',
    }],
    segmentDurationSeconds: 123,
    segmentPrefix: 'segmentPrefix',
    streamSelection: {
      maxVideoBitsPerSecond: 123,
      minVideoBitsPerSecond: 123,
      streamOrder: 'streamOrder',
    },
  },
  dashPackage: {
    adsOnDeliveryRestrictions: 'adsOnDeliveryRestrictions',
    adTriggers: ['adTriggers'],
    encryption: {
      spekeKeyProvider: {
        resourceId: 'resourceId',
        roleArn: 'roleArn',
        systemIds: ['systemIds'],
        url: 'url',

        // the properties below are optional
        certificateArn: 'certificateArn',
        encryptionContractConfiguration: {
          presetSpeke20Audio: 'presetSpeke20Audio',
          presetSpeke20Video: 'presetSpeke20Video',
        },
      },

      // the properties below are optional
      keyRotationIntervalSeconds: 123,
    },
    includeIframeOnlyStream: false,
    manifestLayout: 'manifestLayout',
    manifestWindowSeconds: 123,
    minBufferTimeSeconds: 123,
    minUpdatePeriodSeconds: 123,
    periodTriggers: ['periodTriggers'],
    profile: 'profile',
    segmentDurationSeconds: 123,
    segmentTemplateFormat: 'segmentTemplateFormat',
    streamSelection: {
      maxVideoBitsPerSecond: 123,
      minVideoBitsPerSecond: 123,
      streamOrder: 'streamOrder',
    },
    suggestedPresentationDelaySeconds: 123,
    utcTiming: 'utcTiming',
    utcTimingUri: 'utcTimingUri',
  },
  description: 'description',
  hlsPackage: {
    adMarkers: 'adMarkers',
    adsOnDeliveryRestrictions: 'adsOnDeliveryRestrictions',
    adTriggers: ['adTriggers'],
    encryption: {
      spekeKeyProvider: {
        resourceId: 'resourceId',
        roleArn: 'roleArn',
        systemIds: ['systemIds'],
        url: 'url',

        // the properties below are optional
        certificateArn: 'certificateArn',
        encryptionContractConfiguration: {
          presetSpeke20Audio: 'presetSpeke20Audio',
          presetSpeke20Video: 'presetSpeke20Video',
        },
      },

      // the properties below are optional
      constantInitializationVector: 'constantInitializationVector',
      encryptionMethod: 'encryptionMethod',
      keyRotationIntervalSeconds: 123,
      repeatExtXKey: false,
    },
    includeDvbSubtitles: false,
    includeIframeOnlyStream: false,
    playlistType: 'playlistType',
    playlistWindowSeconds: 123,
    programDateTimeIntervalSeconds: 123,
    segmentDurationSeconds: 123,
    streamSelection: {
      maxVideoBitsPerSecond: 123,
      minVideoBitsPerSecond: 123,
      streamOrder: 'streamOrder',
    },
    useAudioRenditionGroup: false,
  },
  manifestName: 'manifestName',
  mssPackage: {
    encryption: {
      spekeKeyProvider: {
        resourceId: 'resourceId',
        roleArn: 'roleArn',
        systemIds: ['systemIds'],
        url: 'url',

        // the properties below are optional
        certificateArn: 'certificateArn',
        encryptionContractConfiguration: {
          presetSpeke20Audio: 'presetSpeke20Audio',
          presetSpeke20Video: 'presetSpeke20Video',
        },
      },
    },
    manifestWindowSeconds: 123,
    segmentDurationSeconds: 123,
    streamSelection: {
      maxVideoBitsPerSecond: 123,
      minVideoBitsPerSecond: 123,
      streamOrder: 'streamOrder',
    },
  },
  origination: 'origination',
  startoverWindowSeconds: 123,
  tags: [{
    key: 'key',
    value: 'value',
  }],
  timeDelaySeconds: 123,
  whitelist: ['whitelist'],
});

from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_mediapackage as mediapackage

cfn_origin_endpoint = mediapackage.CfnOriginEndpoint(self, "MyCfnOriginEndpoint",
    channel_id="channelId",
    id="id",

    # the properties below are optional
    authorization=mediapackage.CfnOriginEndpoint.AuthorizationProperty(
        cdn_identifier_secret="cdnIdentifierSecret",
        secrets_role_arn="secretsRoleArn"
    ),
    cmaf_package=mediapackage.CfnOriginEndpoint.CmafPackageProperty(
        encryption=mediapackage.CfnOriginEndpoint.CmafEncryptionProperty(
            speke_key_provider=mediapackage.CfnOriginEndpoint.SpekeKeyProviderProperty(
                resource_id="resourceId",
                role_arn="roleArn",
                system_ids=["systemIds"],
                url="url",

                # the properties below are optional
                certificate_arn="certificateArn",
                encryption_contract_configuration=mediapackage.CfnOriginEndpoint.EncryptionContractConfigurationProperty(
                    preset_speke20_audio="presetSpeke20Audio",
                    preset_speke20_video="presetSpeke20Video"
                )
            ),

            # the properties below are optional
            constant_initialization_vector="constantInitializationVector",
            encryption_method="encryptionMethod",
            key_rotation_interval_seconds=123
        ),
        hls_manifests=[mediapackage.CfnOriginEndpoint.HlsManifestProperty(
            id="id",

            # the properties below are optional
            ad_markers="adMarkers",
            ads_on_delivery_restrictions="adsOnDeliveryRestrictions",
            ad_triggers=["adTriggers"],
            include_iframe_only_stream=False,
            manifest_name="manifestName",
            playlist_type="playlistType",
            playlist_window_seconds=123,
            program_date_time_interval_seconds=123,
            url="url"
        )],
        segment_duration_seconds=123,
        segment_prefix="segmentPrefix",
        stream_selection=mediapackage.CfnOriginEndpoint.StreamSelectionProperty(
            max_video_bits_per_second=123,
            min_video_bits_per_second=123,
            stream_order="streamOrder"
        )
    ),
    dash_package=mediapackage.CfnOriginEndpoint.DashPackageProperty(
        ads_on_delivery_restrictions="adsOnDeliveryRestrictions",
        ad_triggers=["adTriggers"],
        encryption=mediapackage.CfnOriginEndpoint.DashEncryptionProperty(
            speke_key_provider=mediapackage.CfnOriginEndpoint.SpekeKeyProviderProperty(
                resource_id="resourceId",
                role_arn="roleArn",
                system_ids=["systemIds"],
                url="url",

                # the properties below are optional
                certificate_arn="certificateArn",
                encryption_contract_configuration=mediapackage.CfnOriginEndpoint.EncryptionContractConfigurationProperty(
                    preset_speke20_audio="presetSpeke20Audio",
                    preset_speke20_video="presetSpeke20Video"
                )
            ),

            # the properties below are optional
            key_rotation_interval_seconds=123
        ),
        include_iframe_only_stream=False,
        manifest_layout="manifestLayout",
        manifest_window_seconds=123,
        min_buffer_time_seconds=123,
        min_update_period_seconds=123,
        period_triggers=["periodTriggers"],
        profile="profile",
        segment_duration_seconds=123,
        segment_template_format="segmentTemplateFormat",
        stream_selection=mediapackage.CfnOriginEndpoint.StreamSelectionProperty(
            max_video_bits_per_second=123,
            min_video_bits_per_second=123,
            stream_order="streamOrder"
        ),
        suggested_presentation_delay_seconds=123,
        utc_timing="utcTiming",
        utc_timing_uri="utcTimingUri"
    ),
    description="description",
    hls_package=mediapackage.CfnOriginEndpoint.HlsPackageProperty(
        ad_markers="adMarkers",
        ads_on_delivery_restrictions="adsOnDeliveryRestrictions",
        ad_triggers=["adTriggers"],
        encryption=mediapackage.CfnOriginEndpoint.HlsEncryptionProperty(
            speke_key_provider=mediapackage.CfnOriginEndpoint.SpekeKeyProviderProperty(
                resource_id="resourceId",
                role_arn="roleArn",
                system_ids=["systemIds"],
                url="url",

                # the properties below are optional
                certificate_arn="certificateArn",
                encryption_contract_configuration=mediapackage.CfnOriginEndpoint.EncryptionContractConfigurationProperty(
                    preset_speke20_audio="presetSpeke20Audio",
                    preset_speke20_video="presetSpeke20Video"
                )
            ),

            # the properties below are optional
            constant_initialization_vector="constantInitializationVector",
            encryption_method="encryptionMethod",
            key_rotation_interval_seconds=123,
            repeat_ext_x_key=False
        ),
        include_dvb_subtitles=False,
        include_iframe_only_stream=False,
        playlist_type="playlistType",
        playlist_window_seconds=123,
        program_date_time_interval_seconds=123,
        segment_duration_seconds=123,
        stream_selection=mediapackage.CfnOriginEndpoint.StreamSelectionProperty(
            max_video_bits_per_second=123,
            min_video_bits_per_second=123,
            stream_order="streamOrder"
        ),
        use_audio_rendition_group=False
    ),
    manifest_name="manifestName",
    mss_package=mediapackage.CfnOriginEndpoint.MssPackageProperty(
        encryption=mediapackage.CfnOriginEndpoint.MssEncryptionProperty(
            speke_key_provider=mediapackage.CfnOriginEndpoint.SpekeKeyProviderProperty(
                resource_id="resourceId",
                role_arn="roleArn",
                system_ids=["systemIds"],
                url="url",

                # the properties below are optional
                certificate_arn="certificateArn",
                encryption_contract_configuration=mediapackage.CfnOriginEndpoint.EncryptionContractConfigurationProperty(
                    preset_speke20_audio="presetSpeke20Audio",
                    preset_speke20_video="presetSpeke20Video"
                )
            )
        ),
        manifest_window_seconds=123,
        segment_duration_seconds=123,
        stream_selection=mediapackage.CfnOriginEndpoint.StreamSelectionProperty(
            max_video_bits_per_second=123,
            min_video_bits_per_second=123,
            stream_order="streamOrder"
        )
    ),
    origination="origination",
    startover_window_seconds=123,
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    time_delay_seconds=123,
    whitelist=["whitelist"]
)

// 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.*;

CfnOriginEndpoint cfnOriginEndpoint = CfnOriginEndpoint.Builder.create(this, "MyCfnOriginEndpoint")
        .channelId("channelId")
        .id("id")

        // the properties below are optional
        .authorization(AuthorizationProperty.builder()
                .cdnIdentifierSecret("cdnIdentifierSecret")
                .secretsRoleArn("secretsRoleArn")
                .build())
        .cmafPackage(CmafPackageProperty.builder()
                .encryption(CmafEncryptionProperty.builder()
                        .spekeKeyProvider(SpekeKeyProviderProperty.builder()
                                .resourceId("resourceId")
                                .roleArn("roleArn")
                                .systemIds(List.of("systemIds"))
                                .url("url")

                                // the properties below are optional
                                .certificateArn("certificateArn")
                                .encryptionContractConfiguration(EncryptionContractConfigurationProperty.builder()
                                        .presetSpeke20Audio("presetSpeke20Audio")
                                        .presetSpeke20Video("presetSpeke20Video")
                                        .build())
                                .build())

                        // the properties below are optional
                        .constantInitializationVector("constantInitializationVector")
                        .encryptionMethod("encryptionMethod")
                        .keyRotationIntervalSeconds(123)
                        .build())
                .hlsManifests(List.of(HlsManifestProperty.builder()
                        .id("id")

                        // the properties below are optional
                        .adMarkers("adMarkers")
                        .adsOnDeliveryRestrictions("adsOnDeliveryRestrictions")
                        .adTriggers(List.of("adTriggers"))
                        .includeIframeOnlyStream(false)
                        .manifestName("manifestName")
                        .playlistType("playlistType")
                        .playlistWindowSeconds(123)
                        .programDateTimeIntervalSeconds(123)
                        .url("url")
                        .build()))
                .segmentDurationSeconds(123)
                .segmentPrefix("segmentPrefix")
                .streamSelection(StreamSelectionProperty.builder()
                        .maxVideoBitsPerSecond(123)
                        .minVideoBitsPerSecond(123)
                        .streamOrder("streamOrder")
                        .build())
                .build())
        .dashPackage(DashPackageProperty.builder()
                .adsOnDeliveryRestrictions("adsOnDeliveryRestrictions")
                .adTriggers(List.of("adTriggers"))
                .encryption(DashEncryptionProperty.builder()
                        .spekeKeyProvider(SpekeKeyProviderProperty.builder()
                                .resourceId("resourceId")
                                .roleArn("roleArn")
                                .systemIds(List.of("systemIds"))
                                .url("url")

                                // the properties below are optional
                                .certificateArn("certificateArn")
                                .encryptionContractConfiguration(EncryptionContractConfigurationProperty.builder()
                                        .presetSpeke20Audio("presetSpeke20Audio")
                                        .presetSpeke20Video("presetSpeke20Video")
                                        .build())
                                .build())

                        // the properties below are optional
                        .keyRotationIntervalSeconds(123)
                        .build())
                .includeIframeOnlyStream(false)
                .manifestLayout("manifestLayout")
                .manifestWindowSeconds(123)
                .minBufferTimeSeconds(123)
                .minUpdatePeriodSeconds(123)
                .periodTriggers(List.of("periodTriggers"))
                .profile("profile")
                .segmentDurationSeconds(123)
                .segmentTemplateFormat("segmentTemplateFormat")
                .streamSelection(StreamSelectionProperty.builder()
                        .maxVideoBitsPerSecond(123)
                        .minVideoBitsPerSecond(123)
                        .streamOrder("streamOrder")
                        .build())
                .suggestedPresentationDelaySeconds(123)
                .utcTiming("utcTiming")
                .utcTimingUri("utcTimingUri")
                .build())
        .description("description")
        .hlsPackage(HlsPackageProperty.builder()
                .adMarkers("adMarkers")
                .adsOnDeliveryRestrictions("adsOnDeliveryRestrictions")
                .adTriggers(List.of("adTriggers"))
                .encryption(HlsEncryptionProperty.builder()
                        .spekeKeyProvider(SpekeKeyProviderProperty.builder()
                                .resourceId("resourceId")
                                .roleArn("roleArn")
                                .systemIds(List.of("systemIds"))
                                .url("url")

                                // the properties below are optional
                                .certificateArn("certificateArn")
                                .encryptionContractConfiguration(EncryptionContractConfigurationProperty.builder()
                                        .presetSpeke20Audio("presetSpeke20Audio")
                                        .presetSpeke20Video("presetSpeke20Video")
                                        .build())
                                .build())

                        // the properties below are optional
                        .constantInitializationVector("constantInitializationVector")
                        .encryptionMethod("encryptionMethod")
                        .keyRotationIntervalSeconds(123)
                        .repeatExtXKey(false)
                        .build())
                .includeDvbSubtitles(false)
                .includeIframeOnlyStream(false)
                .playlistType("playlistType")
                .playlistWindowSeconds(123)
                .programDateTimeIntervalSeconds(123)
                .segmentDurationSeconds(123)
                .streamSelection(StreamSelectionProperty.builder()
                        .maxVideoBitsPerSecond(123)
                        .minVideoBitsPerSecond(123)
                        .streamOrder("streamOrder")
                        .build())
                .useAudioRenditionGroup(false)
                .build())
        .manifestName("manifestName")
        .mssPackage(MssPackageProperty.builder()
                .encryption(MssEncryptionProperty.builder()
                        .spekeKeyProvider(SpekeKeyProviderProperty.builder()
                                .resourceId("resourceId")
                                .roleArn("roleArn")
                                .systemIds(List.of("systemIds"))
                                .url("url")

                                // the properties below are optional
                                .certificateArn("certificateArn")
                                .encryptionContractConfiguration(EncryptionContractConfigurationProperty.builder()
                                        .presetSpeke20Audio("presetSpeke20Audio")
                                        .presetSpeke20Video("presetSpeke20Video")
                                        .build())
                                .build())
                        .build())
                .manifestWindowSeconds(123)
                .segmentDurationSeconds(123)
                .streamSelection(StreamSelectionProperty.builder()
                        .maxVideoBitsPerSecond(123)
                        .minVideoBitsPerSecond(123)
                        .streamOrder("streamOrder")
                        .build())
                .build())
        .origination("origination")
        .startoverWindowSeconds(123)
        .tags(List.of(CfnTag.builder()
                .key("key")
                .value("value")
                .build()))
        .timeDelaySeconds(123)
        .whitelist(List.of("whitelist"))
        .build();

// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.MediaPackage;

var cfnOriginEndpoint = new CfnOriginEndpoint(this, "MyCfnOriginEndpoint", new CfnOriginEndpointProps {
    ChannelId = "channelId",
    Id = "id",

    // the properties below are optional
    Authorization = new AuthorizationProperty {
        CdnIdentifierSecret = "cdnIdentifierSecret",
        SecretsRoleArn = "secretsRoleArn"
    },
    CmafPackage = new CmafPackageProperty {
        Encryption = new CmafEncryptionProperty {
            SpekeKeyProvider = new SpekeKeyProviderProperty {
                ResourceId = "resourceId",
                RoleArn = "roleArn",
                SystemIds = new [] { "systemIds" },
                Url = "url",

                // the properties below are optional
                CertificateArn = "certificateArn",
                EncryptionContractConfiguration = new EncryptionContractConfigurationProperty {
                    PresetSpeke20Audio = "presetSpeke20Audio",
                    PresetSpeke20Video = "presetSpeke20Video"
                }
            },

            // the properties below are optional
            ConstantInitializationVector = "constantInitializationVector",
            EncryptionMethod = "encryptionMethod",
            KeyRotationIntervalSeconds = 123
        },
        HlsManifests = new [] { new HlsManifestProperty {
            Id = "id",

            // the properties below are optional
            AdMarkers = "adMarkers",
            AdsOnDeliveryRestrictions = "adsOnDeliveryRestrictions",
            AdTriggers = new [] { "adTriggers" },
            IncludeIframeOnlyStream = false,
            ManifestName = "manifestName",
            PlaylistType = "playlistType",
            PlaylistWindowSeconds = 123,
            ProgramDateTimeIntervalSeconds = 123,
            Url = "url"
        } },
        SegmentDurationSeconds = 123,
        SegmentPrefix = "segmentPrefix",
        StreamSelection = new StreamSelectionProperty {
            MaxVideoBitsPerSecond = 123,
            MinVideoBitsPerSecond = 123,
            StreamOrder = "streamOrder"
        }
    },
    DashPackage = new DashPackageProperty {
        AdsOnDeliveryRestrictions = "adsOnDeliveryRestrictions",
        AdTriggers = new [] { "adTriggers" },
        Encryption = new DashEncryptionProperty {
            SpekeKeyProvider = new SpekeKeyProviderProperty {
                ResourceId = "resourceId",
                RoleArn = "roleArn",
                SystemIds = new [] { "systemIds" },
                Url = "url",

                // the properties below are optional
                CertificateArn = "certificateArn",
                EncryptionContractConfiguration = new EncryptionContractConfigurationProperty {
                    PresetSpeke20Audio = "presetSpeke20Audio",
                    PresetSpeke20Video = "presetSpeke20Video"
                }
            },

            // the properties below are optional
            KeyRotationIntervalSeconds = 123
        },
        IncludeIframeOnlyStream = false,
        ManifestLayout = "manifestLayout",
        ManifestWindowSeconds = 123,
        MinBufferTimeSeconds = 123,
        MinUpdatePeriodSeconds = 123,
        PeriodTriggers = new [] { "periodTriggers" },
        Profile = "profile",
        SegmentDurationSeconds = 123,
        SegmentTemplateFormat = "segmentTemplateFormat",
        StreamSelection = new StreamSelectionProperty {
            MaxVideoBitsPerSecond = 123,
            MinVideoBitsPerSecond = 123,
            StreamOrder = "streamOrder"
        },
        SuggestedPresentationDelaySeconds = 123,
        UtcTiming = "utcTiming",
        UtcTimingUri = "utcTimingUri"
    },
    Description = "description",
    HlsPackage = new HlsPackageProperty {
        AdMarkers = "adMarkers",
        AdsOnDeliveryRestrictions = "adsOnDeliveryRestrictions",
        AdTriggers = new [] { "adTriggers" },
        Encryption = new HlsEncryptionProperty {
            SpekeKeyProvider = new SpekeKeyProviderProperty {
                ResourceId = "resourceId",
                RoleArn = "roleArn",
                SystemIds = new [] { "systemIds" },
                Url = "url",

                // the properties below are optional
                CertificateArn = "certificateArn",
                EncryptionContractConfiguration = new EncryptionContractConfigurationProperty {
                    PresetSpeke20Audio = "presetSpeke20Audio",
                    PresetSpeke20Video = "presetSpeke20Video"
                }
            },

            // the properties below are optional
            ConstantInitializationVector = "constantInitializationVector",
            EncryptionMethod = "encryptionMethod",
            KeyRotationIntervalSeconds = 123,
            RepeatExtXKey = false
        },
        IncludeDvbSubtitles = false,
        IncludeIframeOnlyStream = false,
        PlaylistType = "playlistType",
        PlaylistWindowSeconds = 123,
        ProgramDateTimeIntervalSeconds = 123,
        SegmentDurationSeconds = 123,
        StreamSelection = new StreamSelectionProperty {
            MaxVideoBitsPerSecond = 123,
            MinVideoBitsPerSecond = 123,
            StreamOrder = "streamOrder"
        },
        UseAudioRenditionGroup = false
    },
    ManifestName = "manifestName",
    MssPackage = new MssPackageProperty {
        Encryption = new MssEncryptionProperty {
            SpekeKeyProvider = new SpekeKeyProviderProperty {
                ResourceId = "resourceId",
                RoleArn = "roleArn",
                SystemIds = new [] { "systemIds" },
                Url = "url",

                // the properties below are optional
                CertificateArn = "certificateArn",
                EncryptionContractConfiguration = new EncryptionContractConfigurationProperty {
                    PresetSpeke20Audio = "presetSpeke20Audio",
                    PresetSpeke20Video = "presetSpeke20Video"
                }
            }
        },
        ManifestWindowSeconds = 123,
        SegmentDurationSeconds = 123,
        StreamSelection = new StreamSelectionProperty {
            MaxVideoBitsPerSecond = 123,
            MinVideoBitsPerSecond = 123,
            StreamOrder = "streamOrder"
        }
    },
    Origination = "origination",
    StartoverWindowSeconds = 123,
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } },
    TimeDelaySeconds = 123,
    Whitelist = new [] { "whitelist" }
});

// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

cfnOriginEndpoint := awscdk.Aws_mediapackage.NewCfnOriginEndpoint(this, jsii.String("MyCfnOriginEndpoint"), &CfnOriginEndpointProps{
	ChannelId: jsii.String("channelId"),
	Id: jsii.String("id"),

	// the properties below are optional
	Authorization: &AuthorizationProperty{
		CdnIdentifierSecret: jsii.String("cdnIdentifierSecret"),
		SecretsRoleArn: jsii.String("secretsRoleArn"),
	},
	CmafPackage: &CmafPackageProperty{
		Encryption: &CmafEncryptionProperty{
			SpekeKeyProvider: &SpekeKeyProviderProperty{
				ResourceId: jsii.String("resourceId"),
				RoleArn: jsii.String("roleArn"),
				SystemIds: []*string{
					jsii.String("systemIds"),
				},
				Url: jsii.String("url"),

				// the properties below are optional
				CertificateArn: jsii.String("certificateArn"),
				EncryptionContractConfiguration: &EncryptionContractConfigurationProperty{
					PresetSpeke20Audio: jsii.String("presetSpeke20Audio"),
					PresetSpeke20Video: jsii.String("presetSpeke20Video"),
				},
			},

			// the properties below are optional
			ConstantInitializationVector: jsii.String("constantInitializationVector"),
			EncryptionMethod: jsii.String("encryptionMethod"),
			KeyRotationIntervalSeconds: jsii.Number(123),
		},
		HlsManifests: []interface{}{
			&HlsManifestProperty{
				Id: jsii.String("id"),

				// the properties below are optional
				AdMarkers: jsii.String("adMarkers"),
				AdsOnDeliveryRestrictions: jsii.String("adsOnDeliveryRestrictions"),
				AdTriggers: []*string{
					jsii.String("adTriggers"),
				},
				IncludeIframeOnlyStream: jsii.Boolean(false),
				ManifestName: jsii.String("manifestName"),
				PlaylistType: jsii.String("playlistType"),
				PlaylistWindowSeconds: jsii.Number(123),
				ProgramDateTimeIntervalSeconds: jsii.Number(123),
				Url: jsii.String("url"),
			},
		},
		SegmentDurationSeconds: jsii.Number(123),
		SegmentPrefix: jsii.String("segmentPrefix"),
		StreamSelection: &StreamSelectionProperty{
			MaxVideoBitsPerSecond: jsii.Number(123),
			MinVideoBitsPerSecond: jsii.Number(123),
			StreamOrder: jsii.String("streamOrder"),
		},
	},
	DashPackage: &DashPackageProperty{
		AdsOnDeliveryRestrictions: jsii.String("adsOnDeliveryRestrictions"),
		AdTriggers: []*string{
			jsii.String("adTriggers"),
		},
		Encryption: &DashEncryptionProperty{
			SpekeKeyProvider: &SpekeKeyProviderProperty{
				ResourceId: jsii.String("resourceId"),
				RoleArn: jsii.String("roleArn"),
				SystemIds: []*string{
					jsii.String("systemIds"),
				},
				Url: jsii.String("url"),

				// the properties below are optional
				CertificateArn: jsii.String("certificateArn"),
				EncryptionContractConfiguration: &EncryptionContractConfigurationProperty{
					PresetSpeke20Audio: jsii.String("presetSpeke20Audio"),
					PresetSpeke20Video: jsii.String("presetSpeke20Video"),
				},
			},

			// the properties below are optional
			KeyRotationIntervalSeconds: jsii.Number(123),
		},
		IncludeIframeOnlyStream: jsii.Boolean(false),
		ManifestLayout: jsii.String("manifestLayout"),
		ManifestWindowSeconds: jsii.Number(123),
		MinBufferTimeSeconds: jsii.Number(123),
		MinUpdatePeriodSeconds: jsii.Number(123),
		PeriodTriggers: []*string{
			jsii.String("periodTriggers"),
		},
		Profile: jsii.String("profile"),
		SegmentDurationSeconds: jsii.Number(123),
		SegmentTemplateFormat: jsii.String("segmentTemplateFormat"),
		StreamSelection: &StreamSelectionProperty{
			MaxVideoBitsPerSecond: jsii.Number(123),
			MinVideoBitsPerSecond: jsii.Number(123),
			StreamOrder: jsii.String("streamOrder"),
		},
		SuggestedPresentationDelaySeconds: jsii.Number(123),
		UtcTiming: jsii.String("utcTiming"),
		UtcTimingUri: jsii.String("utcTimingUri"),
	},
	Description: jsii.String("description"),
	HlsPackage: &HlsPackageProperty{
		AdMarkers: jsii.String("adMarkers"),
		AdsOnDeliveryRestrictions: jsii.String("adsOnDeliveryRestrictions"),
		AdTriggers: []*string{
			jsii.String("adTriggers"),
		},
		Encryption: &HlsEncryptionProperty{
			SpekeKeyProvider: &SpekeKeyProviderProperty{
				ResourceId: jsii.String("resourceId"),
				RoleArn: jsii.String("roleArn"),
				SystemIds: []*string{
					jsii.String("systemIds"),
				},
				Url: jsii.String("url"),

				// the properties below are optional
				CertificateArn: jsii.String("certificateArn"),
				EncryptionContractConfiguration: &EncryptionContractConfigurationProperty{
					PresetSpeke20Audio: jsii.String("presetSpeke20Audio"),
					PresetSpeke20Video: jsii.String("presetSpeke20Video"),
				},
			},

			// the properties below are optional
			ConstantInitializationVector: jsii.String("constantInitializationVector"),
			EncryptionMethod: jsii.String("encryptionMethod"),
			KeyRotationIntervalSeconds: jsii.Number(123),
			RepeatExtXKey: jsii.Boolean(false),
		},
		IncludeDvbSubtitles: jsii.Boolean(false),
		IncludeIframeOnlyStream: jsii.Boolean(false),
		PlaylistType: jsii.String("playlistType"),
		PlaylistWindowSeconds: jsii.Number(123),
		ProgramDateTimeIntervalSeconds: jsii.Number(123),
		SegmentDurationSeconds: jsii.Number(123),
		StreamSelection: &StreamSelectionProperty{
			MaxVideoBitsPerSecond: jsii.Number(123),
			MinVideoBitsPerSecond: jsii.Number(123),
			StreamOrder: jsii.String("streamOrder"),
		},
		UseAudioRenditionGroup: jsii.Boolean(false),
	},
	ManifestName: jsii.String("manifestName"),
	MssPackage: &MssPackageProperty{
		Encryption: &MssEncryptionProperty{
			SpekeKeyProvider: &SpekeKeyProviderProperty{
				ResourceId: jsii.String("resourceId"),
				RoleArn: jsii.String("roleArn"),
				SystemIds: []*string{
					jsii.String("systemIds"),
				},
				Url: jsii.String("url"),

				// the properties below are optional
				CertificateArn: jsii.String("certificateArn"),
				EncryptionContractConfiguration: &EncryptionContractConfigurationProperty{
					PresetSpeke20Audio: jsii.String("presetSpeke20Audio"),
					PresetSpeke20Video: jsii.String("presetSpeke20Video"),
				},
			},
		},
		ManifestWindowSeconds: jsii.Number(123),
		SegmentDurationSeconds: jsii.Number(123),
		StreamSelection: &StreamSelectionProperty{
			MaxVideoBitsPerSecond: jsii.Number(123),
			MinVideoBitsPerSecond: jsii.Number(123),
			StreamOrder: jsii.String("streamOrder"),
		},
	},
	Origination: jsii.String("origination"),
	StartoverWindowSeconds: jsii.Number(123),
	Tags: []CfnTag{
		&CfnTag{
			Key: jsii.String("key"),
			Value: jsii.String("value"),
		},
	},
	TimeDelaySeconds: jsii.Number(123),
	Whitelist: []*string{
		jsii.String("whitelist"),
	},
})

Initializer

new CfnOriginEndpoint(scope: Construct, id: string, props: CfnOriginEndpointProps)

CfnOriginEndpoint(scope: Construct, id: str, props: CfnOriginEndpointProps)

new CfnOriginEndpoint(Construct scope, String id, CfnOriginEndpointProps props)

new CfnOriginEndpoint(Construct scope, string id, CfnOriginEndpointProps props)

NewCfnOriginEndpoint(Scope Construct, Id *string, Props CfnOriginEndpointProps)

Construct Props

authorization?optionalIResolvable | CfnOriginEndpoint.AuthorizationPropertyauthorization?optionaltyping.Union[IResolvable, AuthorizationProperty]authorization?optionalIResolvableAuthorization?optionalIResolvableAuthorization?optionalinterface{}#

Parameters for CDN authorization.

channelIdstringchannel_idstrchannelIdStringChannelIdstringChannelId*stringrequired#

The ID of the channel associated with this endpoint.

cmafPackage?optionalIResolvable | CfnOriginEndpoint.CmafPackagePropertycmaf_package?optionaltyping.Union[IResolvable, CmafPackageProperty]cmafPackage?optionalIResolvableCmafPackage?optionalIResolvableCmafPackage?optionalinterface{}#

Parameters for Common Media Application Format (CMAF) packaging.

dashPackage?optionalIResolvable | CfnOriginEndpoint.DashPackagePropertydash_package?optionaltyping.Union[IResolvable, DashPackageProperty]dashPackage?optionalIResolvableDashPackage?optionalIResolvableDashPackage?optionalinterface{}#

Parameters for DASH packaging.

description?optionalstringdescription?optionalstrdescription?optionalStringDescription?optionalstringDescription?optional*string#

Any descriptive information that you want to add to the endpoint for future identification purposes.

hlsPackage?optionalIResolvable | CfnOriginEndpoint.HlsPackagePropertyhls_package?optionaltyping.Union[IResolvable, HlsPackageProperty]hlsPackage?optionalIResolvableHlsPackage?optionalIResolvableHlsPackage?optionalinterface{}#

Parameters for Apple HLS packaging.

idstringidstridStringIdstringId*stringrequired#

The manifest ID is required and must be unique within the OriginEndpoint.

The ID can't be changed after the endpoint is created.

manifestName?optionalstringmanifest_name?optionalstrmanifestName?optionalStringManifestName?optionalstringManifestName?optional*string#

A short string that's appended to the end of the endpoint URL to create a unique path to this endpoint.

mssPackage?optionalIResolvable | CfnOriginEndpoint.MssPackagePropertymss_package?optionaltyping.Union[IResolvable, MssPackageProperty]mssPackage?optionalIResolvableMssPackage?optionalIResolvableMssPackage?optionalinterface{}#

Parameters for Microsoft Smooth Streaming packaging.

origination?optionalstringorigination?optionalstrorigination?optionalStringOrigination?optionalstringOrigination?optional*string#

Controls video origination from this endpoint.

notes

Valid values:

• ALLOW - enables this endpoint to serve content to requesting devices.
• DENY - prevents this endpoint from serving content. Denying origination is helpful for harvesting live-to-VOD assets. For more information about harvesting and origination, see Live-to-VOD Requirements .

startoverWindowSeconds?optionalnumberstartover_window_seconds?optionalint | floatstartoverWindowSeconds?optionalNumberStartoverWindowSeconds?optionaldoubleStartoverWindowSeconds?optional*float64#

Maximum duration (seconds) of content to retain for startover playback.

Omit this attribute or enter 0 to indicate that startover playback is disabled for this endpoint.

tags?optionalCfnTag[]tags?optionaltyping.List[CfnTag]tags?optionalList<CfnTag>Tags?optionalCfnTag[]Tags?optional*[]CfnTag#

The tags to assign to the endpoint.

timeDelaySeconds?optionalnumbertime_delay_seconds?optionalint | floattimeDelaySeconds?optionalNumberTimeDelaySeconds?optionaldoubleTimeDelaySeconds?optional*float64#

Minimum duration (seconds) of delay to enforce on the playback of live content.

Omit this attribute or enter 0 to indicate that there is no time delay in effect for this endpoint.

whitelist?optionalstring[]whitelist?optionaltyping.List[str]whitelist?optionalList<String>Whitelist?optionalstring[]Whitelist?optional*[]*string#

The IP addresses that can access this endpoint.

Properties

attrArnstringattr_arnstrattrArnStringAttrArnstringAttrArn*string#

The endpoint's unique system-generated resource name, based on the AWS record.

attrUrlstringattr_urlstrattrUrlStringAttrUrlstringAttrUrl*string#

URL for the key provider’s key retrieval API endpoint.

Must start with https://.

authorization?may be undefinedIResolvable | CfnOriginEndpoint.AuthorizationPropertyauthorization?may be undefinedtyping.Union[IResolvable, AuthorizationProperty]authorization?may be undefinedIResolvableAuthorization?may be undefinedIResolvableAuthorization?may be undefinedinterface{}#

Parameters for CDN authorization.

CFN_RESOURCE_TYPE_NAMEstringcfn_resource_type_namestrCFN_RESOURCE_TYPE_NAMEStringCFN_RESOURCE_TYPE_NAMEstringCFN_RESOURCE_TYPE_NAME*stringstatic#

The CloudFormation resource type name for this resource class.

cfnOptionsICfnResourceOptionscfn_optionsICfnResourceOptionscfnOptionsICfnResourceOptionsCfnOptionsICfnResourceOptionsCfnOptionsICfnResourceOptions#

Options for this resource, such as condition, update policy etc.

cfnResourceTypestringcfn_resource_typestrcfnResourceTypeStringCfnResourceTypestringCfnResourceType*string#

AWS resource type.

channelIdstringchannel_idstrchannelIdStringChannelIdstringChannelId*string#

The ID of the channel associated with this endpoint.

cmafPackage?may be undefinedIResolvable | CfnOriginEndpoint.CmafPackagePropertycmaf_package?may be undefinedtyping.Union[IResolvable, CmafPackageProperty]cmafPackage?may be undefinedIResolvableCmafPackage?may be undefinedIResolvableCmafPackage?may be undefinedinterface{}#

Parameters for Common Media Application Format (CMAF) packaging.

creationStackstring[]creation_stacktyping.List[str]creationStackList<String>CreationStackstring[]CreationStack*[]*string#

dashPackage?may be undefinedIResolvable | CfnOriginEndpoint.DashPackagePropertydash_package?may be undefinedtyping.Union[IResolvable, DashPackageProperty]dashPackage?may be undefinedIResolvableDashPackage?may be undefinedIResolvableDashPackage?may be undefinedinterface{}#

Parameters for DASH packaging.

description?may be undefinedstringdescription?may be undefinedstrdescription?may be undefinedStringDescription?may be undefinedstringDescription?may be undefined*string#

Any descriptive information that you want to add to the endpoint for future identification purposes.

envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironment#

hlsPackage?may be undefinedIResolvable | CfnOriginEndpoint.HlsPackagePropertyhls_package?may be undefinedtyping.Union[IResolvable, HlsPackageProperty]hlsPackage?may be undefinedIResolvableHlsPackage?may be undefinedIResolvableHlsPackage?may be undefinedinterface{}#

Parameters for Apple HLS packaging.

idstringidstridStringIdstringId*string#

The manifest ID is required and must be unique within the OriginEndpoint.

logicalIdstringlogical_idstrlogicalIdStringLogicalIdstringLogicalId*string#

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

manifestName?may be undefinedstringmanifest_name?may be undefinedstrmanifestName?may be undefinedStringManifestName?may be undefinedstringManifestName?may be undefined*string#

A short string that's appended to the end of the endpoint URL to create a unique path to this endpoint.

mssPackage?may be undefinedIResolvable | CfnOriginEndpoint.MssPackagePropertymss_package?may be undefinedtyping.Union[IResolvable, MssPackageProperty]mssPackage?may be undefinedIResolvableMssPackage?may be undefinedIResolvableMssPackage?may be undefinedinterface{}#

Parameters for Microsoft Smooth Streaming packaging.

nodeNodenodeNodenodeNodeNodeNodeNodeNode#

The tree node.

origination?may be undefinedstringorigination?may be undefinedstrorigination?may be undefinedStringOrigination?may be undefinedstringOrigination?may be undefined*string#

Controls video origination from this endpoint.

originEndpointRefOriginEndpointReferenceorigin_endpoint_refOriginEndpointReferenceoriginEndpointRefOriginEndpointReferenceOriginEndpointRefOriginEndpointReferenceOriginEndpointRefOriginEndpointReference#

A reference to a OriginEndpoint resource.

refstringrefstrrefStringRefstringRef*string#

Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

stackStackstackStackstackStackStackStackStackStack#

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

startoverWindowSeconds?may be undefinednumberstartover_window_seconds?may be undefinedint | floatstartoverWindowSeconds?may be undefinedNumberStartoverWindowSeconds?may be undefineddoubleStartoverWindowSeconds?may be undefined*float64#

Maximum duration (seconds) of content to retain for startover playback.

tagsTagManagertagsTagManagertagsTagManagerTagsTagManagerTagsTagManager#

Tag Manager which manages the tags for this resource.

tagsRaw?may be undefinedCfnTag[]tags_raw?may be undefinedtyping.List[CfnTag]tagsRaw?may be undefinedList<CfnTag>TagsRaw?may be undefinedCfnTag[]TagsRaw?may be undefined*[]CfnTag#

The tags to assign to the endpoint.

timeDelaySeconds?may be undefinednumbertime_delay_seconds?may be undefinedint | floattimeDelaySeconds?may be undefinedNumberTimeDelaySeconds?may be undefineddoubleTimeDelaySeconds?may be undefined*float64#

Minimum duration (seconds) of delay to enforce on the playback of live content.

whitelist?may be undefinedstring[]whitelist?may be undefinedtyping.List[str]whitelist?may be undefinedList<String>Whitelist?may be undefinedstring[]Whitelist?may be undefined*[]*string#

The IP addresses that can access this endpoint.

Methods

addDeletionOverride(path: string): voiddef add_deletion_override(self, path: str) -> Nonepublic void addDeletionOverride(String path)public void AddDeletionOverride(string path)func AddDeletionOverride(Path *string)#

Syntactic sugar for `addOverride(path, undefined)`.

1 parameter

Parameters

• pathpathpathpathPath — The path of the value to delete.

addDependency(target: CfnResource): voiddef add_dependency(self, target: CfnResource) -> Nonepublic void addDependency(CfnResource target)public void AddDependency(CfnResource target)func AddDependency(Target CfnResource)deprecated#

Use `addResourceDependency` instead.

This method has been renamed to addResourceDependency to more clearly set it apart from construct.node.addDependency. See the documentation of that function for more details.

addDependsOn(target: CfnResource): voiddef add_depends_on(self, target: CfnResource) -> Nonepublic void addDependsOn(CfnResource target)public void AddDependsOn(CfnResource target)func AddDependsOn(Target CfnResource)deprecated#

Use `addResourceDependency` instead.

notes

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

This method has been renamed to addResourceDependency, which makes it more clear that this method operates at a different level from the construct-level construct.node.addDependency() mechanism.

addMetadata(key: string, value: any): voiddef add_metadata(self, key: str, value: Any) -> Nonepublic void addMetadata(String key, Object value)public void AddMetadata(string key, object value)func AddMetadata(Key *string, Value interface{})#

Add a value to the CloudFormation Resource Metadata.

addOverride(path: string, value: any): voiddef add_override(self, path: str, value: Any) -> Nonepublic void addOverride(String path, Object value)public void AddOverride(string path, object value)func AddOverride(Path *string, Value interface{})#

Adds an override to the synthesized CloudFormation resource.

notes · 2 parameters

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters

• pathpathpathpathPath — - The path of the property, you can use dot notation to override values in complex types.
• valuevaluevaluevalueValue — - The value.

addPropertyDeletionOverride(propertyPath: string): voiddef add_property_deletion_override(self, property_path: str) -> Nonepublic void addPropertyDeletionOverride(String propertyPath)public void AddPropertyDeletionOverride(string propertyPath)func AddPropertyDeletionOverride(PropertyPath *string)#

Adds an override that deletes the value of a property from the resource definition.

1 parameter

Parameters

• propertyPathproperty_pathpropertyPathpropertyPathPropertyPath — The path to the property.

addPropertyOverride(propertyPath: string, value: any): voiddef add_property_override(self, property_path: str, value: Any) -> Nonepublic void addPropertyOverride(String propertyPath, Object value)public void AddPropertyOverride(string propertyPath, object value)func AddPropertyOverride(PropertyPath *string, Value interface{})#

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

2 parameters

Parameters

• propertyPathproperty_pathpropertyPathpropertyPathPropertyPath — The path of the property.
• valuevaluevaluevalueValue — The value.

addResourceDependency(target: CfnResource, reason?: string): voiddef add_resource_dependency(self, target: CfnResource, reason: typing.Optional[str] = None) -> Nonepublic void addResourceDependency(CfnResource target, String reason)public void AddResourceDependency(CfnResource target, string? reason = null)func AddResourceDependency(Target CfnResource, Reason *string)#

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

notes

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

This method only adds dependencies between L1 resources. If you are looking for a generic construct-to-construct dependency mechanism that works for all constructs including L2s, use construct.node.addDependency instead.

applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

1 parameter

Parameters

• strengthstrengthstrengthstrengthStrength — - The reference strength to use for this resource.

applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): voiddef apply_removal_policy(self, policy: typing.Optional[RemovalPolicy] = None, options: typing.Optional[RemovalPolicyOptions] = None) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy, RemovalPolicyOptions options)public void ApplyRemovalPolicy(RemovalPolicy? policy = null, RemovalPolicyOptions? options = null)func ApplyRemovalPolicy(Policy RemovalPolicy, Options RemovalPolicyOptions)#

Sets the deletion policy of the resource based on the removal policy specified.

notes

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

arnForOriginEndpoint(resource: IOriginEndpointRef): string@staticmethod def arn_for_origin_endpoint(resource: IOriginEndpointRef) -> strpublic static String arnForOriginEndpoint(IOriginEndpointRef resource)public static string ArnForOriginEndpoint(IOriginEndpointRef resource)func ArnForOriginEndpoint(Resource IOriginEndpointRef) *stringstatic#

cfnPropertyName(cdkPropertyName: string): stringdef cfn_property_name(self, cdk_property_name: str) -> strpublic String cfnPropertyName(String cdkPropertyName)public string CfnPropertyName(string cdkPropertyName)func CfnPropertyName(CdkPropertyName *string) *string#

getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Referencedef get_att(self, attribute_name: str, type_hint: typing.Optional[ResolutionTypeHint] = None) -> Referencepublic Reference getAtt(String attributeName, ResolutionTypeHint typeHint)public Reference GetAtt(string attributeName, ResolutionTypeHint? typeHint = null)func GetAtt(AttributeName *string, TypeHint ResolutionTypeHint) Reference#

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

1 parameter

Parameters

• attributeNameattribute_nameattributeNameattributeNameAttributeName — The name of the attribute.

getMetadata(key: string): anydef get_metadata(self, key: str) -> Anypublic Object getMetadata(String key)public object GetMetadata(string key)func GetMetadata(Key *string) interface{}#

Retrieve a value value from the CloudFormation Resource Metadata.

inspect(inspector: TreeInspector): voiddef inspect(self, inspector: TreeInspector) -> Nonepublic void inspect(TreeInspector inspector)public void Inspect(TreeInspector inspector)func Inspect(Inspector TreeInspector)#

Examines the CloudFormation resource and discloses attributes.

1 parameter

Parameters

• inspectorinspectorinspectorinspectorInspector — tree inspector to collect and process attributes.

isCfnElement(x: any): boolean@staticmethod def is_cfn_element(x: Any) -> boolpublic static Boolean isCfnElement(Object x)public static bool IsCfnElement(object x)func IsCfnElement(X interface{}) *boolstatic#

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

returns

Returns: The construct as a stack element or undefined if it is not a stack element.

isCfnOriginEndpoint(x: any): boolean@staticmethod def is_cfn_origin_endpoint(x: Any) -> boolpublic static Boolean isCfnOriginEndpoint(Object x)public static bool IsCfnOriginEndpoint(object x)func IsCfnOriginEndpoint(X interface{}) *boolstatic#

Checks whether the given object is a CfnOriginEndpoint.

isCfnResource(x: any): boolean@staticmethod def is_cfn_resource(x: Any) -> boolpublic static Boolean isCfnResource(Object x)public static bool IsCfnResource(object x)func IsCfnResource(X interface{}) *boolstatic#

Check whether the given object is a CfnResource.

isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#

Checks if `x` is a construct.

notes · 1 parameter · returns

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters

• xxxxX — Any object.

Returns: true if x is an object created from a class which extends Construct.

obtainDependencies(): Stack | CfnResource[]def obtain_dependencies(self, ) -> typing.List[typing.Union[Stack, CfnResource]]public List<Stack> obtainDependencies()public Stack[] ObtainDependencies()func ObtainDependencies() *[]interface{}#

Retrieves an array of resources and stacks this resource depends on.

For resources depended on directly, returns the CfnResource object. For dependencies on other stacks, returns the Stack object. The order of the array is not guaranteed.

overrideLogicalId(newLogicalId: string): voiddef override_logical_id(self, new_logical_id: str) -> Nonepublic void overrideLogicalId(String newLogicalId)public void OverrideLogicalId(string newLogicalId)func OverrideLogicalId(NewLogicalId *string)#

Overrides the auto-generated logical ID with a specific ID.

1 parameter

Parameters

• newLogicalIdnew_logical_idnewLogicalIdnewLogicalIdNewLogicalId — The new logical ID to use for this stack element.

removeDependency(target: CfnResource): voiddef remove_dependency(self, target: CfnResource) -> Nonepublic void removeDependency(CfnResource target)public void RemoveDependency(CfnResource target)func RemoveDependency(Target CfnResource)deprecated#

Use `removeResourceDependency` instead

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

removeResourceDependency(target: CfnResource): voiddef remove_resource_dependency(self, target: CfnResource) -> Nonepublic void removeResourceDependency(CfnResource target)public void RemoveResourceDependency(CfnResource target)func RemoveResourceDependency(Target CfnResource)#

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

replaceDependency(target: CfnResource, newTarget: CfnResource): voiddef replace_dependency(self, target: CfnResource, new_target: CfnResource) -> Nonepublic void replaceDependency(CfnResource target, CfnResource newTarget)public void ReplaceDependency(CfnResource target, CfnResource newTarget)func ReplaceDependency(Target CfnResource, NewTarget CfnResource)#

Replaces one dependency with another.

2 parameters

Parameters

• targettargettargettargetTarget — The dependency to replace.
• newTargetnew_targetnewTargetnewTargetNewTarget — The new dependency to add.

toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#

Returns a string representation of this construct.

returns

Returns: a string representation of this resource

with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.