CfnSourceLocationPropsMixin

class aws_cdk.mixins_preview.aws_mediatailor.mixins.CfnSourceLocationPropsMixin(props, *, strategy=None)

Bases: Mixin

A source location is a container for sources.

For more information about source locations, see Working with source locations in the MediaTailor User Guide .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-sourcelocation.html
CloudformationResource:: AWS::MediaTailor::SourceLocation
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_mediatailor import mixins as mediatailor_mixins

cfn_source_location_props_mixin = mediatailor_mixins.CfnSourceLocationPropsMixin(mediatailor_mixins.CfnSourceLocationMixinProps(
    access_configuration=mediatailor_mixins.CfnSourceLocationPropsMixin.AccessConfigurationProperty(
        access_type="accessType",
        secrets_manager_access_token_configuration=mediatailor_mixins.CfnSourceLocationPropsMixin.SecretsManagerAccessTokenConfigurationProperty(
            header_name="headerName",
            secret_arn="secretArn",
            secret_string_key="secretStringKey"
        )
    ),
    default_segment_delivery_configuration=mediatailor_mixins.CfnSourceLocationPropsMixin.DefaultSegmentDeliveryConfigurationProperty(
        base_url="baseUrl"
    ),
    http_configuration=mediatailor_mixins.CfnSourceLocationPropsMixin.HttpConfigurationProperty(
        base_url="baseUrl"
    ),
    segment_delivery_configurations=[mediatailor_mixins.CfnSourceLocationPropsMixin.SegmentDeliveryConfigurationProperty(
        base_url="baseUrl",
        name="name"
    )],
    source_location_name="sourceLocationName",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::MediaTailor::SourceLocation.

Parameters:

props (Union[CfnSourceLocationMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['accessConfiguration', 'defaultSegmentDeliveryConfiguration', 'httpConfiguration', 'segmentDeliveryConfigurations', 'sourceLocationName', 'tags']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

AccessConfigurationProperty

class CfnSourceLocationPropsMixin.AccessConfigurationProperty(*, access_type=None, secrets_manager_access_token_configuration=None)

Bases: object

Access configuration parameters.

Parameters:

access_type (Optional[str]) – The type of authentication used to access content from HttpConfiguration::BaseUrl on your source location. Accepted value: S3_SIGV4 . S3_SIGV4 - AWS Signature Version 4 authentication for Amazon S3 hosted virtual-style access. If your source location base URL is an Amazon S3 bucket, MediaTailor can use AWS Signature Version 4 (SigV4) authentication to access the bucket where your source content is stored. Your MediaTailor source location baseURL must follow the S3 virtual hosted-style request URL format. For example, https://bucket-name.s3.Region.amazonaws.com/key-name. Before you can use S3_SIGV4 , you must meet these requirements: • You must allow MediaTailor to access your S3 bucket by granting mediatailor.amazonaws.com principal access in IAM. For information about configuring access in IAM, see Access management in the IAM User Guide. • The mediatailor.amazonaws.com service principal must have permissions to read all top level manifests referenced by the VodSource packaging configurations. • The caller of the API must have s3:GetObject IAM permissions to read all top level manifests referenced by your MediaTailor VodSource packaging configurations.
secrets_manager_access_token_configuration (Union[IResolvable, SecretsManagerAccessTokenConfigurationProperty, Dict[str, Any], None]) – AWS Secrets Manager access token configuration parameters.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-sourcelocation-accessconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_mediatailor import mixins as mediatailor_mixins

access_configuration_property = mediatailor_mixins.CfnSourceLocationPropsMixin.AccessConfigurationProperty(
    access_type="accessType",
    secrets_manager_access_token_configuration=mediatailor_mixins.CfnSourceLocationPropsMixin.SecretsManagerAccessTokenConfigurationProperty(
        header_name="headerName",
        secret_arn="secretArn",
        secret_string_key="secretStringKey"
    )
)

Attributes

access_type

S3_SIGV4 .

S3_SIGV4 - AWS Signature Version 4 authentication for Amazon S3 hosted virtual-style access. If your source location base URL is an Amazon S3 bucket, MediaTailor can use AWS Signature Version 4 (SigV4) authentication to access the bucket where your source content is stored. Your MediaTailor source location baseURL must follow the S3 virtual hosted-style request URL format. For example, https://bucket-name.s3.Region.amazonaws.com/key-name.

Before you can use S3_SIGV4 , you must meet these requirements:

You must allow MediaTailor to access your S3 bucket by granting mediatailor.amazonaws.com principal access in IAM. For information about configuring access in IAM, see Access management in the IAM User Guide.
The mediatailor.amazonaws.com service principal must have permissions to read all top level manifests referenced by the VodSource packaging configurations.
The caller of the API must have s3:GetObject IAM permissions to read all top level manifests referenced by your MediaTailor VodSource packaging configurations.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-sourcelocation-accessconfiguration.html#cfn-mediatailor-sourcelocation-accessconfiguration-accesstype
Type:: The type of authentication used to access content from HttpConfiguration::BaseUrl on your source location. Accepted value

secrets_manager_access_token_configuration

AWS Secrets Manager access token configuration parameters.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-sourcelocation-accessconfiguration.html#cfn-mediatailor-sourcelocation-accessconfiguration-secretsmanageraccesstokenconfiguration

DefaultSegmentDeliveryConfigurationProperty

class CfnSourceLocationPropsMixin.DefaultSegmentDeliveryConfigurationProperty(*, base_url=None)

Bases: object

The optional configuration for a server that serves segments.

Use this if you want the segment delivery server to be different from the source location server. For example, you can configure your source location server to be an origination server, such as MediaPackage, and the segment delivery server to be a content delivery network (CDN), such as CloudFront. If you don’t specify a segment delivery server, then the source location server is used.

Parameters:: base_url (Optional[str]) – The hostname of the server that will be used to serve segments. This string must include the protocol, such as https:// .
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-sourcelocation-defaultsegmentdeliveryconfiguration.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_mediatailor import mixins as mediatailor_mixins

default_segment_delivery_configuration_property = mediatailor_mixins.CfnSourceLocationPropsMixin.DefaultSegmentDeliveryConfigurationProperty(
    base_url="baseUrl"
)

Attributes

base_url

The hostname of the server that will be used to serve segments.

This string must include the protocol, such as https:// .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-sourcelocation-defaultsegmentdeliveryconfiguration.html#cfn-mediatailor-sourcelocation-defaultsegmentdeliveryconfiguration-baseurl

HttpConfigurationProperty

class CfnSourceLocationPropsMixin.HttpConfigurationProperty(*, base_url=None)

Bases: object

The HTTP configuration for the source location.

Parameters:: base_url (Optional[str]) – The base URL for the source location host server. This string must include the protocol, such as https:// .
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-sourcelocation-httpconfiguration.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_mediatailor import mixins as mediatailor_mixins

http_configuration_property = mediatailor_mixins.CfnSourceLocationPropsMixin.HttpConfigurationProperty(
    base_url="baseUrl"
)

Attributes

base_url

The base URL for the source location host server.

This string must include the protocol, such as https:// .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-sourcelocation-httpconfiguration.html#cfn-mediatailor-sourcelocation-httpconfiguration-baseurl

SecretsManagerAccessTokenConfigurationProperty

class CfnSourceLocationPropsMixin.SecretsManagerAccessTokenConfigurationProperty(*, header_name=None, secret_arn=None, secret_string_key=None)

Bases: object

AWS Secrets Manager access token configuration parameters.

For information about Secrets Manager access token authentication, see Working with AWS Secrets Manager access token authentication .

Parameters:

header_name (Optional[str]) – The name of the HTTP header used to supply the access token in requests to the source location.
secret_arn (Optional[str]) – The Amazon Resource Name (ARN) of the AWS Secrets Manager secret that contains the access token.
secret_string_key (Optional[str]) – The AWS Secrets Manager SecretString key associated with the access token. MediaTailor uses the key to look up SecretString key and value pair containing the access token.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-sourcelocation-secretsmanageraccesstokenconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_mediatailor import mixins as mediatailor_mixins

secrets_manager_access_token_configuration_property = mediatailor_mixins.CfnSourceLocationPropsMixin.SecretsManagerAccessTokenConfigurationProperty(
    header_name="headerName",
    secret_arn="secretArn",
    secret_string_key="secretStringKey"
)

Attributes

header_name

The name of the HTTP header used to supply the access token in requests to the source location.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-sourcelocation-secretsmanageraccesstokenconfiguration.html#cfn-mediatailor-sourcelocation-secretsmanageraccesstokenconfiguration-headername

secret_arn

The Amazon Resource Name (ARN) of the AWS Secrets Manager secret that contains the access token.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-sourcelocation-secretsmanageraccesstokenconfiguration.html#cfn-mediatailor-sourcelocation-secretsmanageraccesstokenconfiguration-secretarn

secret_string_key

The AWS Secrets Manager SecretString key associated with the access token. MediaTailor uses the key to look up SecretString key and value pair containing the access token.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-sourcelocation-secretsmanageraccesstokenconfiguration.html#cfn-mediatailor-sourcelocation-secretsmanageraccesstokenconfiguration-secretstringkey

SegmentDeliveryConfigurationProperty

class CfnSourceLocationPropsMixin.SegmentDeliveryConfigurationProperty(*, base_url=None, name=None)

Bases: object

The segment delivery configuration settings.

Parameters:

base_url (Optional[str]) – The base URL of the host or path of the segment delivery server that you’re using to serve segments. This is typically a content delivery network (CDN). The URL can be absolute or relative. To use an absolute URL include the protocol, such as https://example.com/some/path . To use a relative URL specify the relative path, such as /some/path* .
name (Optional[str]) – A unique identifier used to distinguish between multiple segment delivery configurations in a source location.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-sourcelocation-segmentdeliveryconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_mediatailor import mixins as mediatailor_mixins

segment_delivery_configuration_property = mediatailor_mixins.CfnSourceLocationPropsMixin.SegmentDeliveryConfigurationProperty(
    base_url="baseUrl",
    name="name"
)

Attributes

base_url

The base URL of the host or path of the segment delivery server that you’re using to serve segments.

This is typically a content delivery network (CDN). The URL can be absolute or relative. To use an absolute URL include the protocol, such as https://example.com/some/path . To use a relative URL specify the relative path, such as /some/path* .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-sourcelocation-segmentdeliveryconfiguration.html#cfn-mediatailor-sourcelocation-segmentdeliveryconfiguration-baseurl

name

A unique identifier used to distinguish between multiple segment delivery configurations in a source location.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-sourcelocation-segmentdeliveryconfiguration.html#cfn-mediatailor-sourcelocation-segmentdeliveryconfiguration-name