CfnStreamingDistributionPropsMixin

class aws_cdk.mixins_preview.aws_cloudfront.mixins.CfnStreamingDistributionPropsMixin(props, *, strategy=None)

Bases: Mixin

This resource is deprecated.

Amazon CloudFront is deprecating real-time messaging protocol (RTMP) distributions on December 31, 2020. For more information, read the announcement on the Amazon CloudFront discussion forum.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-streamingdistribution.html
CloudformationResource:: AWS::CloudFront::StreamingDistribution
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_cloudfront import mixins as cloudfront_mixins

cfn_streaming_distribution_props_mixin = cloudfront_mixins.CfnStreamingDistributionPropsMixin(cloudfront_mixins.CfnStreamingDistributionMixinProps(
    streaming_distribution_config=cloudfront_mixins.CfnStreamingDistributionPropsMixin.StreamingDistributionConfigProperty(
        aliases=["aliases"],
        comment="comment",
        enabled=False,
        logging=cloudfront_mixins.CfnStreamingDistributionPropsMixin.LoggingProperty(
            bucket="bucket",
            enabled=False,
            prefix="prefix"
        ),
        price_class="priceClass",
        s3_origin=cloudfront_mixins.CfnStreamingDistributionPropsMixin.S3OriginProperty(
            domain_name="domainName",
            origin_access_identity="originAccessIdentity"
        ),
        trusted_signers=cloudfront_mixins.CfnStreamingDistributionPropsMixin.TrustedSignersProperty(
            aws_account_numbers=["awsAccountNumbers"],
            enabled=False
        )
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::CloudFront::StreamingDistribution.

Parameters:

props (Union[CfnStreamingDistributionMixinProps, 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 = ['streamingDistributionConfig', '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

LoggingProperty

class CfnStreamingDistributionPropsMixin.LoggingProperty(*, bucket=None, enabled=None, prefix=None)

Bases: object

A complex type that controls whether access logs are written for the streaming distribution.

Parameters:

bucket (Optional[str]) – The Amazon S3 bucket to store the access logs in, for example, amzn-s3-demo-bucket.s3.amazonaws.com .
enabled (Union[bool, IResolvable, None]) – Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you don’t want to enable logging when you create a streaming distribution or if you want to disable logging for an existing streaming distribution, specify false for Enabled , and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket and Prefix , the values are automatically deleted.
prefix (Optional[str]) – An optional string that you want CloudFront to prefix to the access log filenames for this streaming distribution, for example, myprefix/ . If you want to enable logging, but you don’t want to specify a prefix, you still must include an empty Prefix element in the Logging element.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-streamingdistribution-logging.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_cloudfront import mixins as cloudfront_mixins

logging_property = cloudfront_mixins.CfnStreamingDistributionPropsMixin.LoggingProperty(
    bucket="bucket",
    enabled=False,
    prefix="prefix"
)

Attributes

bucket

The Amazon S3 bucket to store the access logs in, for example, amzn-s3-demo-bucket.s3.amazonaws.com .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-streamingdistribution-logging.html#cfn-cloudfront-streamingdistribution-logging-bucket

enabled

Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket.

If you don’t want to enable logging when you create a streaming distribution or if you want to disable logging for an existing streaming distribution, specify false for Enabled , and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket and Prefix , the values are automatically deleted.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-streamingdistribution-logging.html#cfn-cloudfront-streamingdistribution-logging-enabled

prefix

An optional string that you want CloudFront to prefix to the access log filenames for this streaming distribution, for example, myprefix/ .

If you want to enable logging, but you don’t want to specify a prefix, you still must include an empty Prefix element in the Logging element.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-streamingdistribution-logging.html#cfn-cloudfront-streamingdistribution-logging-prefix

S3OriginProperty

class CfnStreamingDistributionPropsMixin.S3OriginProperty(*, domain_name=None, origin_access_identity=None)

Bases: object

A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution.

Parameters:

domain_name (Optional[str]) – The DNS name of the Amazon S3 origin.
origin_access_identity (Optional[str]) – The CloudFront origin access identity to associate with the distribution. Use an origin access identity to configure the distribution so that end users can only access objects in an Amazon S3 bucket through CloudFront. If you want end users to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty OriginAccessIdentity element. To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty OriginAccessIdentity element. To replace the origin access identity, update the distribution configuration and specify the new origin access identity. For more information, see Using an Origin Access Identity to Restrict Access to Your Amazon S3 Content in the Amazon CloudFront Developer Guide .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-streamingdistribution-s3origin.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_cloudfront import mixins as cloudfront_mixins

s3_origin_property = cloudfront_mixins.CfnStreamingDistributionPropsMixin.S3OriginProperty(
    domain_name="domainName",
    origin_access_identity="originAccessIdentity"
)

Attributes

domain_name

The DNS name of the Amazon S3 origin.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-streamingdistribution-s3origin.html#cfn-cloudfront-streamingdistribution-s3origin-domainname

origin_access_identity

The CloudFront origin access identity to associate with the distribution.

Use an origin access identity to configure the distribution so that end users can only access objects in an Amazon S3 bucket through CloudFront.

If you want end users to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty OriginAccessIdentity element.

To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty OriginAccessIdentity element.

To replace the origin access identity, update the distribution configuration and specify the new origin access identity.

For more information, see Using an Origin Access Identity to Restrict Access to Your Amazon S3 Content in the Amazon CloudFront Developer Guide .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-streamingdistribution-s3origin.html#cfn-cloudfront-streamingdistribution-s3origin-originaccessidentity

StreamingDistributionConfigProperty

class CfnStreamingDistributionPropsMixin.StreamingDistributionConfigProperty(*, aliases=None, comment=None, enabled=None, logging=None, price_class=None, s3_origin=None, trusted_signers=None)

Bases: object

The RTMP distribution’s configuration information.

Parameters:

aliases (Optional[Sequence[str]]) – A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution.
comment (Optional[str]) – Any comments you want to include about the streaming distribution.
enabled (Union[bool, IResolvable, None]) – Whether the streaming distribution is enabled to accept user requests for content.
logging (Union[IResolvable, LoggingProperty, Dict[str, Any], None]) – A complex type that controls whether access logs are written for the streaming distribution.
price_class (Optional[str]) – A complex type that contains information about price class for this streaming distribution.
s3_origin (Union[IResolvable, S3OriginProperty, Dict[str, Any], None]) – A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution.
trusted_signers (Union[IResolvable, TrustedSignersProperty, Dict[str, Any], None]) – A complex type that specifies any AWS accounts that you want to permit to create signed URLs for private content. If you want the distribution to use signed URLs, include this element; if you want the distribution to use public URLs, remove this element. For more information, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-streamingdistribution-streamingdistributionconfig.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_cloudfront import mixins as cloudfront_mixins

streaming_distribution_config_property = cloudfront_mixins.CfnStreamingDistributionPropsMixin.StreamingDistributionConfigProperty(
    aliases=["aliases"],
    comment="comment",
    enabled=False,
    logging=cloudfront_mixins.CfnStreamingDistributionPropsMixin.LoggingProperty(
        bucket="bucket",
        enabled=False,
        prefix="prefix"
    ),
    price_class="priceClass",
    s3_origin=cloudfront_mixins.CfnStreamingDistributionPropsMixin.S3OriginProperty(
        domain_name="domainName",
        origin_access_identity="originAccessIdentity"
    ),
    trusted_signers=cloudfront_mixins.CfnStreamingDistributionPropsMixin.TrustedSignersProperty(
        aws_account_numbers=["awsAccountNumbers"],
        enabled=False
    )
)

Attributes

aliases

A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-streamingdistribution-streamingdistributionconfig.html#cfn-cloudfront-streamingdistribution-streamingdistributionconfig-aliases

comment

Any comments you want to include about the streaming distribution.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-streamingdistribution-streamingdistributionconfig.html#cfn-cloudfront-streamingdistribution-streamingdistributionconfig-comment

enabled

Whether the streaming distribution is enabled to accept user requests for content.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-streamingdistribution-streamingdistributionconfig.html#cfn-cloudfront-streamingdistribution-streamingdistributionconfig-enabled

logging

A complex type that controls whether access logs are written for the streaming distribution.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-streamingdistribution-streamingdistributionconfig.html#cfn-cloudfront-streamingdistribution-streamingdistributionconfig-logging

price_class

A complex type that contains information about price class for this streaming distribution.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-streamingdistribution-streamingdistributionconfig.html#cfn-cloudfront-streamingdistribution-streamingdistributionconfig-priceclass

s3_origin

A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-streamingdistribution-streamingdistributionconfig.html#cfn-cloudfront-streamingdistribution-streamingdistributionconfig-s3origin

trusted_signers

A complex type that specifies any AWS accounts that you want to permit to create signed URLs for private content.

If you want the distribution to use signed URLs, include this element; if you want the distribution to use public URLs, remove this element. For more information, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-streamingdistribution-streamingdistributionconfig.html#cfn-cloudfront-streamingdistribution-streamingdistributionconfig-trustedsigners

TrustedSignersProperty

class CfnStreamingDistributionPropsMixin.TrustedSignersProperty(*, aws_account_numbers=None, enabled=None)

Bases: object

A list of AWS accounts whose public keys CloudFront can use to verify the signatures of signed URLs and signed cookies.

Parameters:

aws_account_numbers (Optional[Sequence[str]]) – An AWS account number that contains active CloudFront key pairs that CloudFront can use to verify the signatures of signed URLs and signed cookies. If the AWS account that owns the key pairs is the same account that owns the CloudFront distribution, the value of this field is self .
enabled (Union[bool, IResolvable, None]) – This field is true if any of the AWS accounts in the list are configured as trusted signers. If not, this field is false .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-streamingdistribution-trustedsigners.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_cloudfront import mixins as cloudfront_mixins

trusted_signers_property = cloudfront_mixins.CfnStreamingDistributionPropsMixin.TrustedSignersProperty(
    aws_account_numbers=["awsAccountNumbers"],
    enabled=False
)

Attributes

aws_account_numbers

An AWS account number that contains active CloudFront key pairs that CloudFront can use to verify the signatures of signed URLs and signed cookies.

If the AWS account that owns the key pairs is the same account that owns the CloudFront distribution, the value of this field is self .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-streamingdistribution-trustedsigners.html#cfn-cloudfront-streamingdistribution-trustedsigners-awsaccountnumbers

enabled

This field is true if any of the AWS accounts in the list are configured as trusted signers.

If not, this field is false .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-streamingdistribution-trustedsigners.html#cfn-cloudfront-streamingdistribution-trustedsigners-enabled