awsmediaconnect

package
v2.11.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 8, 2022 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func CfnFlowEntitlement_CFN_RESOURCE_TYPE_NAME

func CfnFlowEntitlement_CFN_RESOURCE_TYPE_NAME() *string

func CfnFlowEntitlement_IsCfnElement

func CfnFlowEntitlement_IsCfnElement(x interface{}) *bool

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: The construct as a stack element or undefined if it is not a stack element.

func CfnFlowEntitlement_IsCfnResource

func CfnFlowEntitlement_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnFlowEntitlement_IsConstruct

func CfnFlowEntitlement_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnFlowOutput_CFN_RESOURCE_TYPE_NAME

func CfnFlowOutput_CFN_RESOURCE_TYPE_NAME() *string

func CfnFlowOutput_IsCfnElement

func CfnFlowOutput_IsCfnElement(x interface{}) *bool

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: The construct as a stack element or undefined if it is not a stack element.

func CfnFlowOutput_IsCfnResource

func CfnFlowOutput_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnFlowOutput_IsConstruct

func CfnFlowOutput_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnFlowSource_CFN_RESOURCE_TYPE_NAME

func CfnFlowSource_CFN_RESOURCE_TYPE_NAME() *string

func CfnFlowSource_IsCfnElement

func CfnFlowSource_IsCfnElement(x interface{}) *bool

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: The construct as a stack element or undefined if it is not a stack element.

func CfnFlowSource_IsCfnResource

func CfnFlowSource_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnFlowSource_IsConstruct

func CfnFlowSource_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnFlowVpcInterface_CFN_RESOURCE_TYPE_NAME

func CfnFlowVpcInterface_CFN_RESOURCE_TYPE_NAME() *string

func CfnFlowVpcInterface_IsCfnElement

func CfnFlowVpcInterface_IsCfnElement(x interface{}) *bool

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: The construct as a stack element or undefined if it is not a stack element.

func CfnFlowVpcInterface_IsCfnResource

func CfnFlowVpcInterface_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnFlowVpcInterface_IsConstruct

func CfnFlowVpcInterface_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnFlow_CFN_RESOURCE_TYPE_NAME

func CfnFlow_CFN_RESOURCE_TYPE_NAME() *string

func CfnFlow_IsCfnElement

func CfnFlow_IsCfnElement(x interface{}) *bool

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: The construct as a stack element or undefined if it is not a stack element.

func CfnFlow_IsCfnResource

func CfnFlow_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnFlow_IsConstruct

func CfnFlow_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func NewCfnFlowEntitlement_Override

func NewCfnFlowEntitlement_Override(c CfnFlowEntitlement, scope constructs.Construct, id *string, props *CfnFlowEntitlementProps)

Create a new `AWS::MediaConnect::FlowEntitlement`.

func NewCfnFlowOutput_Override

func NewCfnFlowOutput_Override(c CfnFlowOutput, scope constructs.Construct, id *string, props *CfnFlowOutputProps)

Create a new `AWS::MediaConnect::FlowOutput`.

func NewCfnFlowSource_Override

func NewCfnFlowSource_Override(c CfnFlowSource, scope constructs.Construct, id *string, props *CfnFlowSourceProps)

Create a new `AWS::MediaConnect::FlowSource`.

func NewCfnFlowVpcInterface_Override

func NewCfnFlowVpcInterface_Override(c CfnFlowVpcInterface, scope constructs.Construct, id *string, props *CfnFlowVpcInterfaceProps)

Create a new `AWS::MediaConnect::FlowVpcInterface`.

func NewCfnFlow_Override

func NewCfnFlow_Override(c CfnFlow, scope constructs.Construct, id *string, props *CfnFlowProps)

Create a new `AWS::MediaConnect::Flow`.

Types

type CfnFlow

type CfnFlow interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrFlowArn() *string
	AttrFlowAvailabilityZone() *string
	AttrSourceIngestIp() *string
	AttrSourceSourceArn() *string
	AttrSourceSourceIngestPort() *string
	AvailabilityZone() *string
	SetAvailabilityZone(val *string)
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	LogicalId() *string
	Name() *string
	SetName(val *string)
	Node() constructs.Node
	Ref() *string
	Source() interface{}
	SetSource(val interface{})
	SourceFailoverConfig() interface{}
	SetSourceFailoverConfig(val interface{})
	Stack() awscdk.Stack
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::MediaConnect::Flow`.

The AWS::MediaConnect::Flow resource defines a connection between one or more video sources and one or more outputs. For each flow, you specify the transport protocol to use, encryption information, and details for any outputs or entitlements that you want. AWS Elemental MediaConnect returns an ingest endpoint where you can send your live video as a single unicast stream. The service replicates and distributes the video to every output that you specify, whether inside or outside the AWS Cloud. You can also set up entitlements on a flow to allow other AWS accounts to access your content.

TODO: EXAMPLE

func NewCfnFlow

func NewCfnFlow(scope constructs.Construct, id *string, props *CfnFlowProps) CfnFlow

Create a new `AWS::MediaConnect::Flow`.

type CfnFlowEntitlement

type CfnFlowEntitlement interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrEntitlementArn() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	DataTransferSubscriberFeePercent() *float64
	SetDataTransferSubscriberFeePercent(val *float64)
	Description() *string
	SetDescription(val *string)
	Encryption() interface{}
	SetEncryption(val interface{})
	EntitlementStatus() *string
	SetEntitlementStatus(val *string)
	FlowArn() *string
	SetFlowArn(val *string)
	LogicalId() *string
	Name() *string
	SetName(val *string)
	Node() constructs.Node
	Ref() *string
	Stack() awscdk.Stack
	Subscribers() *[]*string
	SetSubscribers(val *[]*string)
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::MediaConnect::FlowEntitlement`.

The AWS::MediaConnect::FlowEntitlement resource defines the permission that an AWS account grants to another AWS account to allow access to the content in a specific AWS Elemental MediaConnect flow. The content originator grants an entitlement to a specific AWS account (the subscriber). When an entitlement is granted, the subscriber can create a flow using the originator's flow as the source. Each flow can have up to 50 entitlements.

TODO: EXAMPLE

func NewCfnFlowEntitlement

func NewCfnFlowEntitlement(scope constructs.Construct, id *string, props *CfnFlowEntitlementProps) CfnFlowEntitlement

Create a new `AWS::MediaConnect::FlowEntitlement`.

type CfnFlowEntitlementProps

type CfnFlowEntitlementProps struct {
	// A description of the entitlement.
	//
	// This description appears only on the MediaConnect console and is not visible outside of the current AWS account.
	Description *string `json:"description" yaml:"description"`
	// The Amazon Resource Name (ARN) of the flow.
	FlowArn *string `json:"flowArn" yaml:"flowArn"`
	// The name of the entitlement.
	//
	// This value must be unique within the current flow.
	Name *string `json:"name" yaml:"name"`
	// The AWS account IDs that you want to share your content with.
	//
	// The receiving accounts (subscribers) will be allowed to create their own flows using your content as the source.
	Subscribers *[]*string `json:"subscribers" yaml:"subscribers"`
	// The percentage of the entitlement data transfer fee that you want the subscriber to be responsible for.
	DataTransferSubscriberFeePercent *float64 `json:"dataTransferSubscriberFeePercent" yaml:"dataTransferSubscriberFeePercent"`
	// The type of encryption that MediaConnect will use on the output that is associated with the entitlement.
	Encryption interface{} `json:"encryption" yaml:"encryption"`
	// An indication of whether the new entitlement should be enabled or disabled as soon as it is created.
	//
	// If you don’t specify the entitlementStatus field in your request, MediaConnect sets it to ENABLED.
	EntitlementStatus *string `json:"entitlementStatus" yaml:"entitlementStatus"`
}

Properties for defining a `CfnFlowEntitlement`.

TODO: EXAMPLE

type CfnFlowEntitlement_EncryptionProperty

type CfnFlowEntitlement_EncryptionProperty struct {
	// The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
	Algorithm *string `json:"algorithm" yaml:"algorithm"`
	// The Amazon Resource Name (ARN) of the role that you created during setup (when you set up MediaConnect as a trusted entity).
	RoleArn *string `json:"roleArn" yaml:"roleArn"`
	// A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content.
	//
	// This parameter is not valid for static key encryption.
	ConstantInitializationVector *string `json:"constantInitializationVector" yaml:"constantInitializationVector"`
	// The value of one of the devices that you configured with your digital rights management (DRM) platform key provider.
	//
	// This parameter is required for SPEKE encryption and is not valid for static key encryption.
	DeviceId *string `json:"deviceId" yaml:"deviceId"`
	// The type of key that is used for the encryption.
	//
	// If you don't specify a `keyType` value, the service uses the default setting ( `static-key` ).
	KeyType *string `json:"keyType" yaml:"keyType"`
	// The AWS Region that the API Gateway proxy endpoint was created in.
	//
	// This parameter is required for SPEKE encryption and is not valid for static key encryption.
	Region *string `json:"region" yaml:"region"`
	// An identifier for the content.
	//
	// The service sends this value to the key server to identify the current endpoint. The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid for static key encryption.
	ResourceId *string `json:"resourceId" yaml:"resourceId"`
	// The ARN of the secret that you created in AWS Secrets Manager to store the encryption key.
	SecretArn *string `json:"secretArn" yaml:"secretArn"`
	// The URL from the API Gateway proxy that you set up to talk to your key server.
	//
	// This parameter is required for SPEKE encryption and is not valid for static key encryption.
	Url *string `json:"url" yaml:"url"`
}

Information about the encryption of the flow.

TODO: EXAMPLE

type CfnFlowOutput

type CfnFlowOutput interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrOutputArn() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CidrAllowList() *[]*string
	SetCidrAllowList(val *[]*string)
	CreationStack() *[]*string
	Description() *string
	SetDescription(val *string)
	Destination() *string
	SetDestination(val *string)
	Encryption() interface{}
	SetEncryption(val interface{})
	FlowArn() *string
	SetFlowArn(val *string)
	LogicalId() *string
	MaxLatency() *float64
	SetMaxLatency(val *float64)
	MinLatency() *float64
	SetMinLatency(val *float64)
	Name() *string
	SetName(val *string)
	Node() constructs.Node
	Port() *float64
	SetPort(val *float64)
	Protocol() *string
	SetProtocol(val *string)
	Ref() *string
	RemoteId() *string
	SetRemoteId(val *string)
	SmoothingLatency() *float64
	SetSmoothingLatency(val *float64)
	Stack() awscdk.Stack
	StreamId() *string
	SetStreamId(val *string)
	UpdatedProperites() *map[string]interface{}
	VpcInterfaceAttachment() interface{}
	SetVpcInterfaceAttachment(val interface{})
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::MediaConnect::FlowOutput`.

The AWS::MediaConnect::FlowOutput resource defines the destination address, protocol, and port that AWS Elemental MediaConnect sends the ingested video to. Each flow can have up to 50 outputs. An output can have the same protocol or a different protocol from the source.

TODO: EXAMPLE

func NewCfnFlowOutput

func NewCfnFlowOutput(scope constructs.Construct, id *string, props *CfnFlowOutputProps) CfnFlowOutput

Create a new `AWS::MediaConnect::FlowOutput`.

type CfnFlowOutputProps

type CfnFlowOutputProps struct {
	// The Amazon Resource Name (ARN) of the flow.
	FlowArn *string `json:"flowArn" yaml:"flowArn"`
	// The protocol to use for the output.
	Protocol *string `json:"protocol" yaml:"protocol"`
	// The range of IP addresses that are allowed to initiate output requests to this flow.
	//
	// Format the IP addresses as a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
	CidrAllowList *[]*string `json:"cidrAllowList" yaml:"cidrAllowList"`
	// A description of the output.
	//
	// This description is not visible outside of the current AWS account even if the account grants entitlements to other accounts.
	Description *string `json:"description" yaml:"description"`
	// The IP address where you want to send the output.
	Destination *string `json:"destination" yaml:"destination"`
	// The encryption credentials that you want to use for the output.
	Encryption interface{} `json:"encryption" yaml:"encryption"`
	// The maximum latency in milliseconds for Zixi-based streams.
	MaxLatency *float64 `json:"maxLatency" yaml:"maxLatency"`
	// The minimum latency in milliseconds for SRT-based streams.
	//
	// In streams that use the SRT protocol, this value that you set on your MediaConnect source or output represents the minimal potential latency of that connection. The latency of the stream is set to the highest number between the sender’s minimum latency and the receiver’s minimum latency.
	MinLatency *float64 `json:"minLatency" yaml:"minLatency"`
	// The name of the VPC interface.
	Name *string `json:"name" yaml:"name"`
	// The port to use when MediaConnect distributes content to the output.
	Port *float64 `json:"port" yaml:"port"`
	// The identifier that is assigned to the Zixi receiver.
	//
	// This parameter applies only to outputs that use Zixi pull.
	RemoteId *string `json:"remoteId" yaml:"remoteId"`
	// The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
	SmoothingLatency *float64 `json:"smoothingLatency" yaml:"smoothingLatency"`
	// The stream ID that you want to use for the transport.
	//
	// This parameter applies only to Zixi-based streams.
	StreamId *string `json:"streamId" yaml:"streamId"`
	// The VPC interface that you want to send your output to.
	VpcInterfaceAttachment interface{} `json:"vpcInterfaceAttachment" yaml:"vpcInterfaceAttachment"`
}

Properties for defining a `CfnFlowOutput`.

TODO: EXAMPLE

type CfnFlowOutput_EncryptionProperty

type CfnFlowOutput_EncryptionProperty struct {
	// The Amazon Resource Name (ARN) of the role that you created during setup (when you set up MediaConnect as a trusted entity).
	RoleArn *string `json:"roleArn" yaml:"roleArn"`
	// The ARN of the secret that you created in AWS Secrets Manager to store the encryption key.
	SecretArn *string `json:"secretArn" yaml:"secretArn"`
	// The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
	Algorithm *string `json:"algorithm" yaml:"algorithm"`
	// The type of key that is used for the encryption.
	//
	// If you don't specify a `keyType` value, the service uses the default setting ( `static-key` ).
	KeyType *string `json:"keyType" yaml:"keyType"`
}

Information about the encryption of the flow.

TODO: EXAMPLE

type CfnFlowOutput_VpcInterfaceAttachmentProperty

type CfnFlowOutput_VpcInterfaceAttachmentProperty struct {
	// The name of the VPC interface that you want to send your output to.
	VpcInterfaceName *string `json:"vpcInterfaceName" yaml:"vpcInterfaceName"`
}

The VPC interface that you want to send your output to.

TODO: EXAMPLE

type CfnFlowProps

type CfnFlowProps struct {
	// The name of the flow.
	Name *string `json:"name" yaml:"name"`
	// The settings for the source that you want to use for the new flow.
	Source interface{} `json:"source" yaml:"source"`
	// The Availability Zone that you want to create the flow in.
	//
	// These options are limited to the Availability Zones within the current AWS Region.
	AvailabilityZone *string `json:"availabilityZone" yaml:"availabilityZone"`
	// The settings for source failover.
	SourceFailoverConfig interface{} `json:"sourceFailoverConfig" yaml:"sourceFailoverConfig"`
}

Properties for defining a `CfnFlow`.

TODO: EXAMPLE

type CfnFlowSource

type CfnFlowSource interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrIngestIp() *string
	AttrSourceArn() *string
	AttrSourceIngestPort() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	Decryption() interface{}
	SetDecryption(val interface{})
	Description() *string
	SetDescription(val *string)
	EntitlementArn() *string
	SetEntitlementArn(val *string)
	FlowArn() *string
	SetFlowArn(val *string)
	IngestPort() *float64
	SetIngestPort(val *float64)
	LogicalId() *string
	MaxBitrate() *float64
	SetMaxBitrate(val *float64)
	MaxLatency() *float64
	SetMaxLatency(val *float64)
	Name() *string
	SetName(val *string)
	Node() constructs.Node
	Protocol() *string
	SetProtocol(val *string)
	Ref() *string
	Stack() awscdk.Stack
	StreamId() *string
	SetStreamId(val *string)
	UpdatedProperites() *map[string]interface{}
	VpcInterfaceName() *string
	SetVpcInterfaceName(val *string)
	WhitelistCidr() *string
	SetWhitelistCidr(val *string)
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::MediaConnect::FlowSource`.

The AWS::MediaConnect::FlowSource resource is the external video content that includes configuration information (encryption and source type) and a network address. Each flow has at least one source. A standard source comes from a source other than another AWS Elemental MediaConnect flow, such as an on-premises encoder. An entitled source comes from a MediaConnect flow that is owned by another AWS account and has granted an entitlement to your account.

Note: MediaConnect does not currently support using CloudFormation to add sources that use the SRT-listener protocol.

TODO: EXAMPLE

func NewCfnFlowSource

func NewCfnFlowSource(scope constructs.Construct, id *string, props *CfnFlowSourceProps) CfnFlowSource

Create a new `AWS::MediaConnect::FlowSource`.

type CfnFlowSourceProps

type CfnFlowSourceProps struct {
	// A description of the source.
	//
	// This description is not visible outside of the current AWS account.
	Description *string `json:"description" yaml:"description"`
	// The name of the source.
	Name *string `json:"name" yaml:"name"`
	// The type of encryption that is used on the content ingested from the source.
	Decryption interface{} `json:"decryption" yaml:"decryption"`
	// The ARN of the entitlement that allows you to subscribe to the flow.
	//
	// The entitlement is set by the content originator, and the ARN is generated as part of the originator's flow.
	EntitlementArn *string `json:"entitlementArn" yaml:"entitlementArn"`
	// The Amazon Resource Name (ARN) of the flow.
	FlowArn *string `json:"flowArn" yaml:"flowArn"`
	// The port that the flow listens on for incoming content.
	//
	// If the protocol of the source is Zixi, the port must be set to 2088.
	IngestPort *float64 `json:"ingestPort" yaml:"ingestPort"`
	// The maximum bitrate for RIST, RTP, and RTP-FEC streams.
	MaxBitrate *float64 `json:"maxBitrate" yaml:"maxBitrate"`
	// The maximum latency in milliseconds.
	//
	// This parameter applies only to RIST-based, Zixi-based, and Fujitsu-based streams.
	MaxLatency *float64 `json:"maxLatency" yaml:"maxLatency"`
	// The protocol that the source uses to deliver the content to MediaConnect.
	Protocol *string `json:"protocol" yaml:"protocol"`
	// The stream ID that you want to use for the transport.
	//
	// This parameter applies only to Zixi-based streams.
	StreamId *string `json:"streamId" yaml:"streamId"`
	// The name of the VPC interface that you want to send your output to.
	VpcInterfaceName *string `json:"vpcInterfaceName" yaml:"vpcInterfaceName"`
	// The range of IP addresses that are allowed to contribute content to your source.
	//
	// Format the IP addresses as a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
	WhitelistCidr *string `json:"whitelistCidr" yaml:"whitelistCidr"`
}

Properties for defining a `CfnFlowSource`.

TODO: EXAMPLE

type CfnFlowSource_EncryptionProperty

type CfnFlowSource_EncryptionProperty struct {
	// The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
	Algorithm *string `json:"algorithm" yaml:"algorithm"`
	// The Amazon Resource Name (ARN) of the role that you created during setup (when you set up MediaConnect as a trusted entity).
	RoleArn *string `json:"roleArn" yaml:"roleArn"`
	// A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content.
	//
	// This parameter is not valid for static key encryption.
	ConstantInitializationVector *string `json:"constantInitializationVector" yaml:"constantInitializationVector"`
	// The value of one of the devices that you configured with your digital rights management (DRM) platform key provider.
	//
	// This parameter is required for SPEKE encryption and is not valid for static key encryption.
	DeviceId *string `json:"deviceId" yaml:"deviceId"`
	// The type of key that is used for the encryption.
	//
	// If you don't specify a `keyType` value, the service uses the default setting ( `static-key` ).
	KeyType *string `json:"keyType" yaml:"keyType"`
	// The AWS Region that the API Gateway proxy endpoint was created in.
	//
	// This parameter is required for SPEKE encryption and is not valid for static key encryption.
	Region *string `json:"region" yaml:"region"`
	// An identifier for the content.
	//
	// The service sends this value to the key server to identify the current endpoint. The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid for static key encryption.
	ResourceId *string `json:"resourceId" yaml:"resourceId"`
	// The ARN of the secret that you created in AWS Secrets Manager to store the encryption key.
	SecretArn *string `json:"secretArn" yaml:"secretArn"`
	// The URL from the API Gateway proxy that you set up to talk to your key server.
	//
	// This parameter is required for SPEKE encryption and is not valid for static key encryption.
	Url *string `json:"url" yaml:"url"`
}

Information about the encryption of the flow.

TODO: EXAMPLE

type CfnFlowVpcInterface

type CfnFlowVpcInterface interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrNetworkInterfaceIds() *[]*string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	FlowArn() *string
	SetFlowArn(val *string)
	LogicalId() *string
	Name() *string
	SetName(val *string)
	Node() constructs.Node
	Ref() *string
	RoleArn() *string
	SetRoleArn(val *string)
	SecurityGroupIds() *[]*string
	SetSecurityGroupIds(val *[]*string)
	Stack() awscdk.Stack
	SubnetId() *string
	SetSubnetId(val *string)
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::MediaConnect::FlowVpcInterface`.

The AWS::MediaConnect::FlowVpcInterface resource is a connection between your AWS Elemental MediaConnect flow and a virtual private cloud (VPC) that you created using the Amazon Virtual Private Cloud service.

To avoid streaming your content over the public internet, you can add up to two VPC interfaces to your flow and use those connections to transfer content between your VPC and MediaConnect.

You can update an existing flow to add a VPC interface. If you haven’t created the flow yet, you must create the flow with a temporary standard source by doing the following:

- Use CloudFormation to create a flow with a standard source that uses to the flow’s public IP address. - Use CloudFormation to create a VPC interface to add to this flow. This can also be done as part of the previous step. - After CloudFormation has created the flow and the VPC interface, update the source to point to the VPC interface that you created.

TODO: EXAMPLE

func NewCfnFlowVpcInterface

func NewCfnFlowVpcInterface(scope constructs.Construct, id *string, props *CfnFlowVpcInterfaceProps) CfnFlowVpcInterface

Create a new `AWS::MediaConnect::FlowVpcInterface`.

type CfnFlowVpcInterfaceProps

type CfnFlowVpcInterfaceProps struct {
	// The Amazon Resource Name (ARN) of the flow.
	FlowArn *string `json:"flowArn" yaml:"flowArn"`
	// The name of the VPC Interface.
	//
	// This value must be unique within the current flow.
	Name *string `json:"name" yaml:"name"`
	// The Amazon Resource Name (ARN) of the role that you created when you set up MediaConnect as a trusted service.
	RoleArn *string `json:"roleArn" yaml:"roleArn"`
	// The VPC security groups that you want MediaConnect to use for your VPC configuration.
	//
	// You must include at least one security group in the request.
	SecurityGroupIds *[]*string `json:"securityGroupIds" yaml:"securityGroupIds"`
	// The subnet IDs that you want to use for your VPC interface.
	//
	// A range of IP addresses in your VPC. When you create your VPC, you specify a range of IPv4 addresses for the VPC in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16. This is the primary CIDR block for your VPC. When you create a subnet for your VPC, you specify the CIDR block for the subnet, which is a subset of the VPC CIDR block.
	//
	// The subnets that you use across all VPC interfaces on the flow must be in the same Availability Zone as the flow.
	SubnetId *string `json:"subnetId" yaml:"subnetId"`
}

Properties for defining a `CfnFlowVpcInterface`.

TODO: EXAMPLE

type CfnFlow_EncryptionProperty

type CfnFlow_EncryptionProperty struct {
	// The Amazon Resource Name (ARN) of the role that you created during setup (when you set up MediaConnect as a trusted entity).
	RoleArn *string `json:"roleArn" yaml:"roleArn"`
	// The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
	Algorithm *string `json:"algorithm" yaml:"algorithm"`
	// A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content.
	//
	// This parameter is not valid for static key encryption.
	ConstantInitializationVector *string `json:"constantInitializationVector" yaml:"constantInitializationVector"`
	// The value of one of the devices that you configured with your digital rights management (DRM) platform key provider.
	//
	// This parameter is required for SPEKE encryption and is not valid for static key encryption.
	DeviceId *string `json:"deviceId" yaml:"deviceId"`
	// The type of key that is used for the encryption.
	//
	// If you don't specify a `keyType` value, the service uses the default setting ( `static-key` ).
	KeyType *string `json:"keyType" yaml:"keyType"`
	// The AWS Region that the API Gateway proxy endpoint was created in.
	//
	// This parameter is required for SPEKE encryption and is not valid for static key encryption.
	Region *string `json:"region" yaml:"region"`
	// An identifier for the content.
	//
	// The service sends this value to the key server to identify the current endpoint. The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid for static key encryption.
	ResourceId *string `json:"resourceId" yaml:"resourceId"`
	// The ARN of the secret that you created in AWS Secrets Manager to store the encryption key.
	SecretArn *string `json:"secretArn" yaml:"secretArn"`
	// The URL from the API Gateway proxy that you set up to talk to your key server.
	//
	// This parameter is required for SPEKE encryption and is not valid for static key encryption.
	Url *string `json:"url" yaml:"url"`
}

Information about the encryption of the flow.

TODO: EXAMPLE

type CfnFlow_FailoverConfigProperty

type CfnFlow_FailoverConfigProperty struct {
	// The size of the buffer (delay) that the service maintains.
	//
	// A larger buffer means a longer delay in transmitting the stream, but more room for error correction. A smaller buffer means a shorter delay, but less room for error correction.
	RecoveryWindow *float64 `json:"recoveryWindow" yaml:"recoveryWindow"`
	// The state of source failover on the flow.
	//
	// If the state is disabled, the flow can have only one source. If the state is enabled, the flow can have one or two sources.
	State *string `json:"state" yaml:"state"`
}

The settings for source failover.

TODO: EXAMPLE

type CfnFlow_SourceProperty

type CfnFlow_SourceProperty struct {
	// The type of encryption that is used on the content ingested from the source.
	Decryption interface{} `json:"decryption" yaml:"decryption"`
	// A description of the source.
	//
	// This description is not visible outside of the current AWS account.
	Description *string `json:"description" yaml:"description"`
	// The ARN of the entitlement that allows you to subscribe to content that comes from another AWS account.
	//
	// The entitlement is set by the content originator and the ARN is generated as part of the originator’s flow.
	EntitlementArn *string `json:"entitlementArn" yaml:"entitlementArn"`
	// The IP address that the flow listens on for incoming content.
	IngestIp *string `json:"ingestIp" yaml:"ingestIp"`
	// The port that the flow listens on for incoming content.
	//
	// If the protocol of the source is Zixi, the port must be set to 2088.
	IngestPort *float64 `json:"ingestPort" yaml:"ingestPort"`
	// The maximum bitrate for RIST, RTP, and RTP-FEC streams.
	MaxBitrate *float64 `json:"maxBitrate" yaml:"maxBitrate"`
	// The maximum latency in milliseconds for a RIST or Zixi-based source.
	MaxLatency *float64 `json:"maxLatency" yaml:"maxLatency"`
	// The minimum latency in milliseconds for SRT-based streams.
	//
	// In streams that use the SRT protocol, this value that you set on your MediaConnect source or output represents the minimal potential latency of that connection. The latency of the stream is set to the highest number between the sender’s minimum latency and the receiver’s minimum latency.
	MinLatency *float64 `json:"minLatency" yaml:"minLatency"`
	// The name of the source.
	Name *string `json:"name" yaml:"name"`
	// The protocol that is used by the source.
	//
	// For a full list of available protocols, see: [Source protocols](https://docs.aws.amazon.com/mediaconnect/latest/api/v1-flows-flowarn-source.html#v1-flows-flowarn-source-prop-setsourcerequest-protocol) in the *AWS Elemental MediaConnect API Reference* .
	Protocol *string `json:"protocol" yaml:"protocol"`
	// The ARN of the source.
	SourceArn *string `json:"sourceArn" yaml:"sourceArn"`
	// The port that the flow will be listening on for incoming content.
	SourceIngestPort *string `json:"sourceIngestPort" yaml:"sourceIngestPort"`
	// The stream ID that you want to use for the transport.
	//
	// This parameter applies only to Zixi-based streams.
	StreamId *string `json:"streamId" yaml:"streamId"`
	// The name of the VPC interface that the source content comes from.
	VpcInterfaceName *string `json:"vpcInterfaceName" yaml:"vpcInterfaceName"`
	// The range of IP addresses that are allowed to contribute content to your source.
	//
	// Format the IP addresses as a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
	WhitelistCidr *string `json:"whitelistCidr" yaml:"whitelistCidr"`
}

The details of the sources of the flow.

If you are creating a flow with a VPC source, you must first create the flow with a temporary standard source by doing the following:

- Use CloudFormation to create a flow with a standard source that uses the flow’s public IP address. - Use CloudFormation to create the VPC interface to add to this flow. This can also be done as part of the previous step. - After CloudFormation has created the flow and the VPC interface, update the source to point to the VPC interface that you created.

TODO: EXAMPLE

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL