AWS CDK Reference

Appearance

v2.273.0

StreamingDistributionConfigProperty Struct ​

The RTMP distribution's configuration information.

Source
Generated code
Type last changed
v2.93.0 · 23 Aug 2023

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_cloudfront as cloudfront } from 'aws-cdk-lib';
const streamingDistributionConfigProperty: cloudfront.CfnStreamingDistribution.StreamingDistributionConfigProperty = {
  comment: 'comment',
  enabled: false,
  s3Origin: {
    domainName: 'domainName',
    originAccessIdentity: 'originAccessIdentity',
  },
  trustedSigners: {
    enabled: false,

    // the properties below are optional
    awsAccountNumbers: ['awsAccountNumbers'],
  },

  // the properties below are optional
  aliases: ['aliases'],
  logging: {
    bucket: 'bucket',
    enabled: false,
    prefix: 'prefix',
  },
  priceClass: 'priceClass',
};

Properties ​

aliasesstring[]aliasestyping.List[str]aliasesList<String>Aliasesstring[]Aliases*[]*string#
A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution.
commentstringcommentstrcommentStringCommentstringComment*stringrequired#
Any comments you want to include about the streaming distribution.
enabledboolean | IResolvableenabledtyping.Union[bool, IResolvable]enabledBooleanEnabledboolEnabledinterface{}required#
Whether the streaming distribution is enabled to accept user requests for content.
loggingIResolvable | CfnStreamingDistribution.LoggingPropertyloggingtyping.Union[IResolvable, LoggingProperty]loggingIResolvableLoggingIResolvableLogginginterface{}#
A complex type that controls whether access logs are written for the streaming distribution.
priceClassstringprice_classstrpriceClassStringPriceClassstringPriceClass*string#
A complex type that contains information about price class for this streaming distribution.
s3OriginIResolvable | CfnStreamingDistribution.S3OriginPropertys3_origintyping.Union[IResolvable, S3OriginProperty]s3OriginIResolvableS3OriginIResolvableS3Origininterface{}required#
A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution.
trustedSignersIResolvable | CfnStreamingDistribution.TrustedSignersPropertytrusted_signerstyping.Union[IResolvable, TrustedSignersProperty]trustedSignersIResolvableTrustedSignersIResolvableTrustedSignersinterface{}required#
A complex type that specifies any AWS accounts that you want to permit to create signed URLs for private content.
notes

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 .