The highest tagged major version is v2.

awsmediaconnect

package

v1.168.0-devpreview Latest Latest Go to latest Published: Aug 9, 2022 License: Apache-2.0 Imports: 6 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/aws/aws-cdk-go

README ¶

AWS::MediaConnect Construct Library

This module is part of the AWS Cloud Development Kit project.

import mediaconnect "github.com/aws/aws-cdk-go/awscdk"

There are no official hand-written (L2) constructs for this service yet. Here are some suggestions on how to proceed:

Search Construct Hub for MediaConnect construct libraries
Use the automatically generated L1 constructs, in the same way you would use the CloudFormation AWS::MediaConnect resources directly.

There are no hand-written (L2) constructs for this service yet. However, you can still use the automatically generated L1 constructs, and use this service exactly as you would using CloudFormation directly.

For more information on the resources and properties available for this service, see the CloudFormation documentation for AWS::MediaConnect.

(Read the CDK Contributing Guide and submit an RFC if you are interested in contributing to this construct library.)

Documentation ¶

Index ¶

func CfnFlowEntitlement_CFN_RESOURCE_TYPE_NAME() *string
func CfnFlowEntitlement_IsCfnElement(x interface{}) *bool
func CfnFlowEntitlement_IsCfnResource(construct constructs.IConstruct) *bool
func CfnFlowEntitlement_IsConstruct(x interface{}) *bool
func CfnFlowOutput_CFN_RESOURCE_TYPE_NAME() *string
func CfnFlowOutput_IsCfnElement(x interface{}) *bool
func CfnFlowOutput_IsCfnResource(construct constructs.IConstruct) *bool
func CfnFlowOutput_IsConstruct(x interface{}) *bool
func CfnFlowSource_CFN_RESOURCE_TYPE_NAME() *string
func CfnFlowSource_IsCfnElement(x interface{}) *bool
func CfnFlowSource_IsCfnResource(construct constructs.IConstruct) *bool
func CfnFlowSource_IsConstruct(x interface{}) *bool
func CfnFlowVpcInterface_CFN_RESOURCE_TYPE_NAME() *string
func CfnFlowVpcInterface_IsCfnElement(x interface{}) *bool
func CfnFlowVpcInterface_IsCfnResource(construct constructs.IConstruct) *bool
func CfnFlowVpcInterface_IsConstruct(x interface{}) *bool
func CfnFlow_CFN_RESOURCE_TYPE_NAME() *string
func CfnFlow_IsCfnElement(x interface{}) *bool
func CfnFlow_IsCfnResource(construct constructs.IConstruct) *bool
func CfnFlow_IsConstruct(x interface{}) *bool
func NewCfnFlowEntitlement_Override(c CfnFlowEntitlement, scope awscdk.Construct, id *string, ...)
func NewCfnFlowOutput_Override(c CfnFlowOutput, scope awscdk.Construct, id *string, props *CfnFlowOutputProps)
func NewCfnFlowSource_Override(c CfnFlowSource, scope awscdk.Construct, id *string, props *CfnFlowSourceProps)
func NewCfnFlowVpcInterface_Override(c CfnFlowVpcInterface, scope awscdk.Construct, id *string, ...)
func NewCfnFlow_Override(c CfnFlow, scope awscdk.Construct, id *string, props *CfnFlowProps)
type CfnFlow
- func NewCfnFlow(scope awscdk.Construct, id *string, props *CfnFlowProps) CfnFlow
type CfnFlowEntitlement
- func NewCfnFlowEntitlement(scope awscdk.Construct, id *string, props *CfnFlowEntitlementProps) CfnFlowEntitlement
type CfnFlowEntitlementProps
type CfnFlowEntitlement_EncryptionProperty
type CfnFlowOutput
- func NewCfnFlowOutput(scope awscdk.Construct, id *string, props *CfnFlowOutputProps) CfnFlowOutput
type CfnFlowOutputProps
type CfnFlowOutput_EncryptionProperty
type CfnFlowOutput_VpcInterfaceAttachmentProperty
type CfnFlowProps
type CfnFlowSource
- func NewCfnFlowSource(scope awscdk.Construct, id *string, props *CfnFlowSourceProps) CfnFlowSource
type CfnFlowSourceProps
type CfnFlowSource_EncryptionProperty
type CfnFlowVpcInterface
- func NewCfnFlowVpcInterface(scope awscdk.Construct, id *string, props *CfnFlowVpcInterfaceProps) CfnFlowVpcInterface
type CfnFlowVpcInterfaceProps
type CfnFlow_EncryptionProperty
type CfnFlow_FailoverConfigProperty
type CfnFlow_SourceProperty

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. Experimental.

func CfnFlowEntitlement_IsCfnResource ¶

func CfnFlowEntitlement_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnFlowEntitlement_IsConstruct ¶

func CfnFlowEntitlement_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

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. Experimental.

func CfnFlowOutput_IsCfnResource ¶

func CfnFlowOutput_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnFlowOutput_IsConstruct ¶

func CfnFlowOutput_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

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. Experimental.

func CfnFlowSource_IsCfnResource ¶

func CfnFlowSource_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnFlowSource_IsConstruct ¶

func CfnFlowSource_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

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. Experimental.

func CfnFlowVpcInterface_IsCfnResource ¶

func CfnFlowVpcInterface_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnFlowVpcInterface_IsConstruct ¶

func CfnFlowVpcInterface_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

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. Experimental.

func CfnFlow_IsCfnResource ¶

func CfnFlow_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnFlow_IsConstruct ¶

func CfnFlow_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func NewCfnFlowEntitlement_Override ¶

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

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

func NewCfnFlowOutput_Override ¶

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

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

func NewCfnFlowSource_Override ¶

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

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

func NewCfnFlowVpcInterface_Override ¶

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

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

func NewCfnFlow_Override ¶

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

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

Types ¶

type CfnFlow ¶

type CfnFlow interface {
	awscdk.CfnResource
	awscdk.IInspectable
	// The Amazon Resource Name (ARN) of the flow.
	AttrFlowArn() *string
	// The Availability Zone that the flow was created in.
	//
	// These options are limited to the Availability Zones within the current AWS Region.
	AttrFlowAvailabilityZone() *string
	// The IP address that the flow listens on for incoming content.
	AttrSourceIngestIp() *string
	// The ARN of the source.
	AttrSourceSourceArn() *string
	// The port that the flow will be listening on for incoming content.
	AttrSourceSourceIngestPort() *string
	// 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
	SetAvailabilityZone(val *string)
	// Options for this resource, such as condition, update policy etc.
	// Experimental.
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	// AWS resource type.
	// Experimental.
	CfnResourceType() *string
	// Returns: the stack trace of the point where this Resource was created from, sourced
	// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
	// node +internal+ entries filtered.
	// Experimental.
	CreationStack() *[]*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)`.
	//
	// Returns: the logical ID as a stringified token. This value will only get
	// resolved during synthesis.
	// Experimental.
	LogicalId() *string
	// The name of the flow.
	Name() *string
	SetName(val *string)
	// The construct tree node associated with this construct.
	// Experimental.
	Node() awscdk.ConstructNode
	// 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 })`.
	// Experimental.
	Ref() *string
	// The settings for the source that you want to use for the new flow.
	Source() interface{}
	SetSource(val interface{})
	// The settings for source failover.
	SourceFailoverConfig() interface{}
	SetSourceFailoverConfig(val interface{})
	// The stack in which this element is defined.
	//
	// CfnElements must be defined within a stack scope (directly or indirectly).
	// Experimental.
	Stack() awscdk.Stack
	// Return properties modified after initiation.
	//
	// Resources that expose mutable properties should override this function to
	// collect and return the properties object for this resource.
	// Experimental.
	UpdatedProperites() *map[string]interface{}
	// Syntactic sugar for `addOverride(path, undefined)`.
	// Experimental.
	AddDeletionOverride(path *string)
	// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
	//
	// This can be used for resources across stacks (or nested stack) boundaries
	// and the dependency will automatically be transferred to the relevant scope.
	// Experimental.
	AddDependsOn(target awscdk.CfnResource)
	// Add a value to the CloudFormation Resource Metadata.
	// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
	//
	// Note that this is a different set of metadata from CDK node metadata; this
	// metadata ends up in the stack template under the resource, whereas CDK
	// node metadata ends up in the Cloud Assembly.
	//
	// Experimental.
	AddMetadata(key *string, value interface{})
	// Adds an override to the synthesized CloudFormation resource.
	//
	// 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,
	// “`typescript
	// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
	// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
	// “`
	// would add the overrides
	// “`json
	// "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.
	// Experimental.
	AddOverride(path *string, value interface{})
	// Adds an override that deletes the value of a property from the resource definition.
	// Experimental.
	AddPropertyDeletionOverride(propertyPath *string)
	// Adds an override to a resource property.
	//
	// Syntactic sugar for `addOverride("Properties.<...>", value)`.
	// Experimental.
	AddPropertyOverride(propertyPath *string, value interface{})
	// Sets the deletion policy of the resource based on the removal policy specified.
	//
	// 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`).
	// Experimental.
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	// 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.
	// Experimental.
	GetAtt(attributeName *string) awscdk.Reference
	// Retrieve a value value from the CloudFormation Resource Metadata.
	// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
	//
	// Note that this is a different set of metadata from CDK node metadata; this
	// metadata ends up in the stack template under the resource, whereas CDK
	// node metadata ends up in the Cloud Assembly.
	//
	// Experimental.
	GetMetadata(key *string) interface{}
	// Examines the CloudFormation resource and discloses attributes.
	Inspect(inspector awscdk.TreeInspector)
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	// Experimental.
	OnPrepare()
	// Allows this construct to emit artifacts into the cloud assembly during synthesis.
	//
	// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
	// as they participate in synthesizing the cloud assembly.
	// Experimental.
	OnSynthesize(session constructs.ISynthesisSession)
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	// Experimental.
	OnValidate() *[]*string
	// Overrides the auto-generated logical ID with a specific ID.
	// Experimental.
	OverrideLogicalId(newLogicalId *string)
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	// Experimental.
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
	//
	// Returns: `true` if the resource should be included or `false` is the resource
	// should be omitted.
	// Experimental.
	ShouldSynthesize() *bool
	// Allows this construct to emit artifacts into the cloud assembly during synthesis.
	//
	// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
	// as they participate in synthesizing the cloud assembly.
	// Experimental.
	Synthesize(session awscdk.ISynthesisSession)
	// Returns a string representation of this construct.
	//
	// Returns: a string representation of this resource.
	// Experimental.
	ToString() *string
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	// Experimental.
	Validate() *[]*string
	// Experimental.
	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.

Example:

// 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"

cfnFlow := awscdk.Aws_mediaconnect.NewCfnFlow(this, jsii.String("MyCfnFlow"), &cfnFlowProps{
	name: jsii.String("name"),
	source: &sourceProperty{
		decryption: &encryptionProperty{
			roleArn: jsii.String("roleArn"),

			// the properties below are optional
			algorithm: jsii.String("algorithm"),
			constantInitializationVector: jsii.String("constantInitializationVector"),
			deviceId: jsii.String("deviceId"),
			keyType: jsii.String("keyType"),
			region: jsii.String("region"),
			resourceId: jsii.String("resourceId"),
			secretArn: jsii.String("secretArn"),
			url: jsii.String("url"),
		},
		description: jsii.String("description"),
		entitlementArn: jsii.String("entitlementArn"),
		ingestIp: jsii.String("ingestIp"),
		ingestPort: jsii.Number(123),
		maxBitrate: jsii.Number(123),
		maxLatency: jsii.Number(123),
		minLatency: jsii.Number(123),
		name: jsii.String("name"),
		protocol: jsii.String("protocol"),
		sourceArn: jsii.String("sourceArn"),
		sourceIngestPort: jsii.String("sourceIngestPort"),
		streamId: jsii.String("streamId"),
		vpcInterfaceName: jsii.String("vpcInterfaceName"),
		whitelistCidr: jsii.String("whitelistCidr"),
	},

	// the properties below are optional
	availabilityZone: jsii.String("availabilityZone"),
	sourceFailoverConfig: &failoverConfigProperty{
		recoveryWindow: jsii.Number(123),
		state: jsii.String("state"),
	},
})

func NewCfnFlow ¶

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

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

type CfnFlowEntitlement ¶

type CfnFlowEntitlement interface {
	awscdk.CfnResource
	awscdk.IInspectable
	// The entitlement ARN.
	AttrEntitlementArn() *string
	// Options for this resource, such as condition, update policy etc.
	// Experimental.
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	// AWS resource type.
	// Experimental.
	CfnResourceType() *string
	// Returns: the stack trace of the point where this Resource was created from, sourced
	// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
	// node +internal+ entries filtered.
	// Experimental.
	CreationStack() *[]*string
	// The percentage of the entitlement data transfer fee that you want the subscriber to be responsible for.
	DataTransferSubscriberFeePercent() *float64
	SetDataTransferSubscriberFeePercent(val *float64)
	// 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
	SetDescription(val *string)
	// The type of encryption that MediaConnect will use on the output that is associated with the entitlement.
	Encryption() interface{}
	SetEncryption(val interface{})
	// 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
	SetEntitlementStatus(val *string)
	// The Amazon Resource Name (ARN) of the flow.
	FlowArn() *string
	SetFlowArn(val *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)`.
	//
	// Returns: the logical ID as a stringified token. This value will only get
	// resolved during synthesis.
	// Experimental.
	LogicalId() *string
	// The name of the entitlement.
	//
	// This value must be unique within the current flow.
	Name() *string
	SetName(val *string)
	// The construct tree node associated with this construct.
	// Experimental.
	Node() awscdk.ConstructNode
	// 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 })`.
	// Experimental.
	Ref() *string
	// The stack in which this element is defined.
	//
	// CfnElements must be defined within a stack scope (directly or indirectly).
	// Experimental.
	Stack() awscdk.Stack
	// 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
	SetSubscribers(val *[]*string)
	// Return properties modified after initiation.
	//
	// Resources that expose mutable properties should override this function to
	// collect and return the properties object for this resource.
	// Experimental.
	UpdatedProperites() *map[string]interface{}
	// Syntactic sugar for `addOverride(path, undefined)`.
	// Experimental.
	AddDeletionOverride(path *string)
	// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
	//
	// This can be used for resources across stacks (or nested stack) boundaries
	// and the dependency will automatically be transferred to the relevant scope.
	// Experimental.
	AddDependsOn(target awscdk.CfnResource)
	// Add a value to the CloudFormation Resource Metadata.
	// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
	//
	// Note that this is a different set of metadata from CDK node metadata; this
	// metadata ends up in the stack template under the resource, whereas CDK
	// node metadata ends up in the Cloud Assembly.
	//
	// Experimental.
	AddMetadata(key *string, value interface{})
	// Adds an override to the synthesized CloudFormation resource.
	//
	// 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,
	// “`typescript
	// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
	// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
	// “`
	// would add the overrides
	// “`json
	// "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.
	// Experimental.
	AddOverride(path *string, value interface{})
	// Adds an override that deletes the value of a property from the resource definition.
	// Experimental.
	AddPropertyDeletionOverride(propertyPath *string)
	// Adds an override to a resource property.
	//
	// Syntactic sugar for `addOverride("Properties.<...>", value)`.
	// Experimental.
	AddPropertyOverride(propertyPath *string, value interface{})
	// Sets the deletion policy of the resource based on the removal policy specified.
	//
	// 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`).
	// Experimental.
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	// 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.
	// Experimental.
	GetAtt(attributeName *string) awscdk.Reference
	// Retrieve a value value from the CloudFormation Resource Metadata.
	// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
	//
	// Note that this is a different set of metadata from CDK node metadata; this
	// metadata ends up in the stack template under the resource, whereas CDK
	// node metadata ends up in the Cloud Assembly.
	//
	// Experimental.
	GetMetadata(key *string) interface{}
	// Examines the CloudFormation resource and discloses attributes.
	Inspect(inspector awscdk.TreeInspector)
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	// Experimental.
	OnPrepare()
	// Allows this construct to emit artifacts into the cloud assembly during synthesis.
	//
	// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
	// as they participate in synthesizing the cloud assembly.
	// Experimental.
	OnSynthesize(session constructs.ISynthesisSession)
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	// Experimental.
	OnValidate() *[]*string
	// Overrides the auto-generated logical ID with a specific ID.
	// Experimental.
	OverrideLogicalId(newLogicalId *string)
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	// Experimental.
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
	//
	// Returns: `true` if the resource should be included or `false` is the resource
	// should be omitted.
	// Experimental.
	ShouldSynthesize() *bool
	// Allows this construct to emit artifacts into the cloud assembly during synthesis.
	//
	// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
	// as they participate in synthesizing the cloud assembly.
	// Experimental.
	Synthesize(session awscdk.ISynthesisSession)
	// Returns a string representation of this construct.
	//
	// Returns: a string representation of this resource.
	// Experimental.
	ToString() *string
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	// Experimental.
	Validate() *[]*string
	// Experimental.
	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.

Example:

// 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"

cfnFlowEntitlement := awscdk.Aws_mediaconnect.NewCfnFlowEntitlement(this, jsii.String("MyCfnFlowEntitlement"), &cfnFlowEntitlementProps{
	description: jsii.String("description"),
	flowArn: jsii.String("flowArn"),
	name: jsii.String("name"),
	subscribers: []*string{
		jsii.String("subscribers"),
	},

	// the properties below are optional
	dataTransferSubscriberFeePercent: jsii.Number(123),
	encryption: &encryptionProperty{
		algorithm: jsii.String("algorithm"),
		roleArn: jsii.String("roleArn"),

		// the properties below are optional
		constantInitializationVector: jsii.String("constantInitializationVector"),
		deviceId: jsii.String("deviceId"),
		keyType: jsii.String("keyType"),
		region: jsii.String("region"),
		resourceId: jsii.String("resourceId"),
		secretArn: jsii.String("secretArn"),
		url: jsii.String("url"),
	},
	entitlementStatus: jsii.String("entitlementStatus"),
})

func NewCfnFlowEntitlement ¶

func NewCfnFlowEntitlement(scope awscdk.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 `field:"required" json:"description" yaml:"description"`
	// The Amazon Resource Name (ARN) of the flow.
	FlowArn *string `field:"required" json:"flowArn" yaml:"flowArn"`
	// The name of the entitlement.
	//
	// This value must be unique within the current flow.
	Name *string `field:"required" 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 `field:"required" json:"subscribers" yaml:"subscribers"`
	// The percentage of the entitlement data transfer fee that you want the subscriber to be responsible for.
	DataTransferSubscriberFeePercent *float64 `field:"optional" json:"dataTransferSubscriberFeePercent" yaml:"dataTransferSubscriberFeePercent"`
	// The type of encryption that MediaConnect will use on the output that is associated with the entitlement.
	Encryption interface{} `field:"optional" 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 `field:"optional" json:"entitlementStatus" yaml:"entitlementStatus"`
}

Properties for defining a `CfnFlowEntitlement`.

Example:

// 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"

cfnFlowEntitlementProps := &cfnFlowEntitlementProps{
	description: jsii.String("description"),
	flowArn: jsii.String("flowArn"),
	name: jsii.String("name"),
	subscribers: []*string{
		jsii.String("subscribers"),
	},

	// the properties below are optional
	dataTransferSubscriberFeePercent: jsii.Number(123),
	encryption: &encryptionProperty{
		algorithm: jsii.String("algorithm"),
		roleArn: jsii.String("roleArn"),

		// the properties below are optional
		constantInitializationVector: jsii.String("constantInitializationVector"),
		deviceId: jsii.String("deviceId"),
		keyType: jsii.String("keyType"),
		region: jsii.String("region"),
		resourceId: jsii.String("resourceId"),
		secretArn: jsii.String("secretArn"),
		url: jsii.String("url"),
	},
	entitlementStatus: jsii.String("entitlementStatus"),
}

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 `field:"required" 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 `field:"required" 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 `field:"optional" 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 `field:"optional" 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 `field:"optional" 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 `field:"optional" 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 `field:"optional" json:"resourceId" yaml:"resourceId"`
	// The ARN of the secret that you created in AWS Secrets Manager to store the encryption key.
	SecretArn *string `field:"optional" 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 `field:"optional" json:"url" yaml:"url"`
}

Information about the encryption of the flow.

Example:

// 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"

encryptionProperty := &encryptionProperty{
	algorithm: jsii.String("algorithm"),
	roleArn: jsii.String("roleArn"),

	// the properties below are optional
	constantInitializationVector: jsii.String("constantInitializationVector"),
	deviceId: jsii.String("deviceId"),
	keyType: jsii.String("keyType"),
	region: jsii.String("region"),
	resourceId: jsii.String("resourceId"),
	secretArn: jsii.String("secretArn"),
	url: jsii.String("url"),
}

type CfnFlowOutput ¶

type CfnFlowOutput interface {
	awscdk.CfnResource
	awscdk.IInspectable
	// The ARN of the output.
	AttrOutputArn() *string
	// Options for this resource, such as condition, update policy etc.
	// Experimental.
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	// AWS resource type.
	// Experimental.
	CfnResourceType() *string
	// 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
	SetCidrAllowList(val *[]*string)
	// Returns: the stack trace of the point where this Resource was created from, sourced
	// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
	// node +internal+ entries filtered.
	// Experimental.
	CreationStack() *[]*string
	// 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
	SetDescription(val *string)
	// The IP address where you want to send the output.
	Destination() *string
	SetDestination(val *string)
	// The encryption credentials that you want to use for the output.
	Encryption() interface{}
	SetEncryption(val interface{})
	// The Amazon Resource Name (ARN) of the flow.
	FlowArn() *string
	SetFlowArn(val *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)`.
	//
	// Returns: the logical ID as a stringified token. This value will only get
	// resolved during synthesis.
	// Experimental.
	LogicalId() *string
	// The maximum latency in milliseconds for Zixi-based streams.
	MaxLatency() *float64
	SetMaxLatency(val *float64)
	// 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
	SetMinLatency(val *float64)
	// The name of the VPC interface.
	Name() *string
	SetName(val *string)
	// The construct tree node associated with this construct.
	// Experimental.
	Node() awscdk.ConstructNode
	// The port to use when MediaConnect distributes content to the output.
	Port() *float64
	SetPort(val *float64)
	// The protocol to use for the output.
	Protocol() *string
	SetProtocol(val *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 })`.
	// Experimental.
	Ref() *string
	// The identifier that is assigned to the Zixi receiver.
	//
	// This parameter applies only to outputs that use Zixi pull.
	RemoteId() *string
	SetRemoteId(val *string)
	// The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
	SmoothingLatency() *float64
	SetSmoothingLatency(val *float64)
	// The stack in which this element is defined.
	//
	// CfnElements must be defined within a stack scope (directly or indirectly).
	// Experimental.
	Stack() awscdk.Stack
	// The stream ID that you want to use for the transport.
	//
	// This parameter applies only to Zixi-based streams.
	StreamId() *string
	SetStreamId(val *string)
	// Return properties modified after initiation.
	//
	// Resources that expose mutable properties should override this function to
	// collect and return the properties object for this resource.
	// Experimental.
	UpdatedProperites() *map[string]interface{}
	// The VPC interface that you want to send your output to.
	VpcInterfaceAttachment() interface{}
	SetVpcInterfaceAttachment(val interface{})
	// Syntactic sugar for `addOverride(path, undefined)`.
	// Experimental.
	AddDeletionOverride(path *string)
	// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
	//
	// This can be used for resources across stacks (or nested stack) boundaries
	// and the dependency will automatically be transferred to the relevant scope.
	// Experimental.
	AddDependsOn(target awscdk.CfnResource)
	// Add a value to the CloudFormation Resource Metadata.
	// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
	//
	// Note that this is a different set of metadata from CDK node metadata; this
	// metadata ends up in the stack template under the resource, whereas CDK
	// node metadata ends up in the Cloud Assembly.
	//
	// Experimental.
	AddMetadata(key *string, value interface{})
	// Adds an override to the synthesized CloudFormation resource.
	//
	// 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,
	// “`typescript
	// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
	// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
	// “`
	// would add the overrides
	// “`json
	// "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.
	// Experimental.
	AddOverride(path *string, value interface{})
	// Adds an override that deletes the value of a property from the resource definition.
	// Experimental.
	AddPropertyDeletionOverride(propertyPath *string)
	// Adds an override to a resource property.
	//
	// Syntactic sugar for `addOverride("Properties.<...>", value)`.
	// Experimental.
	AddPropertyOverride(propertyPath *string, value interface{})
	// Sets the deletion policy of the resource based on the removal policy specified.
	//
	// 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`).
	// Experimental.
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	// 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.
	// Experimental.
	GetAtt(attributeName *string) awscdk.Reference
	// Retrieve a value value from the CloudFormation Resource Metadata.
	// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
	//
	// Note that this is a different set of metadata from CDK node metadata; this
	// metadata ends up in the stack template under the resource, whereas CDK
	// node metadata ends up in the Cloud Assembly.
	//
	// Experimental.
	GetMetadata(key *string) interface{}
	// Examines the CloudFormation resource and discloses attributes.
	Inspect(inspector awscdk.TreeInspector)
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	// Experimental.
	OnPrepare()
	// Allows this construct to emit artifacts into the cloud assembly during synthesis.
	//
	// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
	// as they participate in synthesizing the cloud assembly.
	// Experimental.
	OnSynthesize(session constructs.ISynthesisSession)
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	// Experimental.
	OnValidate() *[]*string
	// Overrides the auto-generated logical ID with a specific ID.
	// Experimental.
	OverrideLogicalId(newLogicalId *string)
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	// Experimental.
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
	//
	// Returns: `true` if the resource should be included or `false` is the resource
	// should be omitted.
	// Experimental.
	ShouldSynthesize() *bool
	// Allows this construct to emit artifacts into the cloud assembly during synthesis.
	//
	// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
	// as they participate in synthesizing the cloud assembly.
	// Experimental.
	Synthesize(session awscdk.ISynthesisSession)
	// Returns a string representation of this construct.
	//
	// Returns: a string representation of this resource.
	// Experimental.
	ToString() *string
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	// Experimental.
	Validate() *[]*string
	// Experimental.
	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.

Example:

// 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"

cfnFlowOutput := awscdk.Aws_mediaconnect.NewCfnFlowOutput(this, jsii.String("MyCfnFlowOutput"), &cfnFlowOutputProps{
	flowArn: jsii.String("flowArn"),
	protocol: jsii.String("protocol"),

	// the properties below are optional
	cidrAllowList: []*string{
		jsii.String("cidrAllowList"),
	},
	description: jsii.String("description"),
	destination: jsii.String("destination"),
	encryption: &encryptionProperty{
		roleArn: jsii.String("roleArn"),
		secretArn: jsii.String("secretArn"),

		// the properties below are optional
		algorithm: jsii.String("algorithm"),
		keyType: jsii.String("keyType"),
	},
	maxLatency: jsii.Number(123),
	minLatency: jsii.Number(123),
	name: jsii.String("name"),
	port: jsii.Number(123),
	remoteId: jsii.String("remoteId"),
	smoothingLatency: jsii.Number(123),
	streamId: jsii.String("streamId"),
	vpcInterfaceAttachment: &vpcInterfaceAttachmentProperty{
		vpcInterfaceName: jsii.String("vpcInterfaceName"),
	},
})

func NewCfnFlowOutput ¶

func NewCfnFlowOutput(scope awscdk.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 `field:"required" json:"flowArn" yaml:"flowArn"`
	// The protocol to use for the output.
	Protocol *string `field:"required" 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 `field:"optional" 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 `field:"optional" json:"description" yaml:"description"`
	// The IP address where you want to send the output.
	Destination *string `field:"optional" json:"destination" yaml:"destination"`
	// The encryption credentials that you want to use for the output.
	Encryption interface{} `field:"optional" json:"encryption" yaml:"encryption"`
	// The maximum latency in milliseconds for Zixi-based streams.
	MaxLatency *float64 `field:"optional" 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 `field:"optional" json:"minLatency" yaml:"minLatency"`
	// The name of the VPC interface.
	Name *string `field:"optional" json:"name" yaml:"name"`
	// The port to use when MediaConnect distributes content to the output.
	Port *float64 `field:"optional" 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 `field:"optional" json:"remoteId" yaml:"remoteId"`
	// The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
	SmoothingLatency *float64 `field:"optional" 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 `field:"optional" json:"streamId" yaml:"streamId"`
	// The VPC interface that you want to send your output to.
	VpcInterfaceAttachment interface{} `field:"optional" json:"vpcInterfaceAttachment" yaml:"vpcInterfaceAttachment"`
}

Properties for defining a `CfnFlowOutput`.

Example:

// 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"

cfnFlowOutputProps := &cfnFlowOutputProps{
	flowArn: jsii.String("flowArn"),
	protocol: jsii.String("protocol"),

	// the properties below are optional
	cidrAllowList: []*string{
		jsii.String("cidrAllowList"),
	},
	description: jsii.String("description"),
	destination: jsii.String("destination"),
	encryption: &encryptionProperty{
		roleArn: jsii.String("roleArn"),
		secretArn: jsii.String("secretArn"),

		// the properties below are optional
		algorithm: jsii.String("algorithm"),
		keyType: jsii.String("keyType"),
	},
	maxLatency: jsii.Number(123),
	minLatency: jsii.Number(123),
	name: jsii.String("name"),
	port: jsii.Number(123),
	remoteId: jsii.String("remoteId"),
	smoothingLatency: jsii.Number(123),
	streamId: jsii.String("streamId"),
	vpcInterfaceAttachment: &vpcInterfaceAttachmentProperty{
		vpcInterfaceName: jsii.String("vpcInterfaceName"),
	},
}

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 `field:"required" json:"roleArn" yaml:"roleArn"`
	// The ARN of the secret that you created in AWS Secrets Manager to store the encryption key.
	SecretArn *string `field:"required" json:"secretArn" yaml:"secretArn"`
	// The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
	Algorithm *string `field:"optional" 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 `field:"optional" json:"keyType" yaml:"keyType"`
}

Information about the encryption of the flow.

Example:

// 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"

encryptionProperty := &encryptionProperty{
	roleArn: jsii.String("roleArn"),
	secretArn: jsii.String("secretArn"),

	// the properties below are optional
	algorithm: jsii.String("algorithm"),
	keyType: jsii.String("keyType"),
}

type CfnFlowOutput_VpcInterfaceAttachmentProperty ¶

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

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

Example:

// 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"

vpcInterfaceAttachmentProperty := &vpcInterfaceAttachmentProperty{
	vpcInterfaceName: jsii.String("vpcInterfaceName"),
}

type CfnFlowProps ¶

type CfnFlowProps struct {
	// The name of the flow.
	Name *string `field:"required" json:"name" yaml:"name"`
	// The settings for the source that you want to use for the new flow.
	Source interface{} `field:"required" 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 `field:"optional" json:"availabilityZone" yaml:"availabilityZone"`
	// The settings for source failover.
	SourceFailoverConfig interface{} `field:"optional" json:"sourceFailoverConfig" yaml:"sourceFailoverConfig"`
}

Properties for defining a `CfnFlow`.

Example:

// 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"

cfnFlowProps := &cfnFlowProps{
	name: jsii.String("name"),
	source: &sourceProperty{
		decryption: &encryptionProperty{
			roleArn: jsii.String("roleArn"),

			// the properties below are optional
			algorithm: jsii.String("algorithm"),
			constantInitializationVector: jsii.String("constantInitializationVector"),
			deviceId: jsii.String("deviceId"),
			keyType: jsii.String("keyType"),
			region: jsii.String("region"),
			resourceId: jsii.String("resourceId"),
			secretArn: jsii.String("secretArn"),
			url: jsii.String("url"),
		},
		description: jsii.String("description"),
		entitlementArn: jsii.String("entitlementArn"),
		ingestIp: jsii.String("ingestIp"),
		ingestPort: jsii.Number(123),
		maxBitrate: jsii.Number(123),
		maxLatency: jsii.Number(123),
		minLatency: jsii.Number(123),
		name: jsii.String("name"),
		protocol: jsii.String("protocol"),
		sourceArn: jsii.String("sourceArn"),
		sourceIngestPort: jsii.String("sourceIngestPort"),
		streamId: jsii.String("streamId"),
		vpcInterfaceName: jsii.String("vpcInterfaceName"),
		whitelistCidr: jsii.String("whitelistCidr"),
	},

	// the properties below are optional
	availabilityZone: jsii.String("availabilityZone"),
	sourceFailoverConfig: &failoverConfigProperty{
		recoveryWindow: jsii.Number(123),
		state: jsii.String("state"),
	},
}

type CfnFlowSource ¶

type CfnFlowSource interface {
	awscdk.CfnResource
	awscdk.IInspectable
	// The IP address that the flow listens on for incoming content.
	AttrIngestIp() *string
	// The ARN of the source.
	AttrSourceArn() *string
	AttrSourceIngestPort() *string
	// Options for this resource, such as condition, update policy etc.
	// Experimental.
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	// AWS resource type.
	// Experimental.
	CfnResourceType() *string
	// Returns: the stack trace of the point where this Resource was created from, sourced
	// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
	// node +internal+ entries filtered.
	// Experimental.
	CreationStack() *[]*string
	// The type of encryption that is used on the content ingested from the source.
	Decryption() interface{}
	SetDecryption(val interface{})
	// A description of the source.
	//
	// This description is not visible outside of the current AWS account.
	Description() *string
	SetDescription(val *string)
	// 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
	SetEntitlementArn(val *string)
	// The Amazon Resource Name (ARN) of the flow.
	FlowArn() *string
	SetFlowArn(val *string)
	// 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
	SetIngestPort(val *float64)
	// 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)`.
	//
	// Returns: the logical ID as a stringified token. This value will only get
	// resolved during synthesis.
	// Experimental.
	LogicalId() *string
	// The maximum bitrate for RIST, RTP, and RTP-FEC streams.
	MaxBitrate() *float64
	SetMaxBitrate(val *float64)
	// The maximum latency in milliseconds.
	//
	// This parameter applies only to RIST-based, Zixi-based, and Fujitsu-based streams.
	MaxLatency() *float64
	SetMaxLatency(val *float64)
	// The name of the source.
	Name() *string
	SetName(val *string)
	// The construct tree node associated with this construct.
	// Experimental.
	Node() awscdk.ConstructNode
	// The protocol that the source uses to deliver the content to MediaConnect.
	Protocol() *string
	SetProtocol(val *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 })`.
	// Experimental.
	Ref() *string
	// The stack in which this element is defined.
	//
	// CfnElements must be defined within a stack scope (directly or indirectly).
	// Experimental.
	Stack() awscdk.Stack
	// The stream ID that you want to use for the transport.
	//
	// This parameter applies only to Zixi-based streams.
	StreamId() *string
	SetStreamId(val *string)
	// Return properties modified after initiation.
	//
	// Resources that expose mutable properties should override this function to
	// collect and return the properties object for this resource.
	// Experimental.
	UpdatedProperites() *map[string]interface{}
	// The name of the VPC interface that you want to send your output to.
	VpcInterfaceName() *string
	SetVpcInterfaceName(val *string)
	// 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
	SetWhitelistCidr(val *string)
	// Syntactic sugar for `addOverride(path, undefined)`.
	// Experimental.
	AddDeletionOverride(path *string)
	// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
	//
	// This can be used for resources across stacks (or nested stack) boundaries
	// and the dependency will automatically be transferred to the relevant scope.
	// Experimental.
	AddDependsOn(target awscdk.CfnResource)
	// Add a value to the CloudFormation Resource Metadata.
	// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
	//
	// Note that this is a different set of metadata from CDK node metadata; this
	// metadata ends up in the stack template under the resource, whereas CDK
	// node metadata ends up in the Cloud Assembly.
	//
	// Experimental.
	AddMetadata(key *string, value interface{})
	// Adds an override to the synthesized CloudFormation resource.
	//
	// 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,
	// “`typescript
	// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
	// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
	// “`
	// would add the overrides
	// “`json
	// "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.
	// Experimental.
	AddOverride(path *string, value interface{})
	// Adds an override that deletes the value of a property from the resource definition.
	// Experimental.
	AddPropertyDeletionOverride(propertyPath *string)
	// Adds an override to a resource property.
	//
	// Syntactic sugar for `addOverride("Properties.<...>", value)`.
	// Experimental.
	AddPropertyOverride(propertyPath *string, value interface{})
	// Sets the deletion policy of the resource based on the removal policy specified.
	//
	// 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`).
	// Experimental.
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	// 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.
	// Experimental.
	GetAtt(attributeName *string) awscdk.Reference
	// Retrieve a value value from the CloudFormation Resource Metadata.
	// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
	//
	// Note that this is a different set of metadata from CDK node metadata; this
	// metadata ends up in the stack template under the resource, whereas CDK
	// node metadata ends up in the Cloud Assembly.
	//
	// Experimental.
	GetMetadata(key *string) interface{}
	// Examines the CloudFormation resource and discloses attributes.
	Inspect(inspector awscdk.TreeInspector)
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	// Experimental.
	OnPrepare()
	// Allows this construct to emit artifacts into the cloud assembly during synthesis.
	//
	// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
	// as they participate in synthesizing the cloud assembly.
	// Experimental.
	OnSynthesize(session constructs.ISynthesisSession)
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	// Experimental.
	OnValidate() *[]*string
	// Overrides the auto-generated logical ID with a specific ID.
	// Experimental.
	OverrideLogicalId(newLogicalId *string)
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	// Experimental.
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
	//
	// Returns: `true` if the resource should be included or `false` is the resource
	// should be omitted.
	// Experimental.
	ShouldSynthesize() *bool
	// Allows this construct to emit artifacts into the cloud assembly during synthesis.
	//
	// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
	// as they participate in synthesizing the cloud assembly.
	// Experimental.
	Synthesize(session awscdk.ISynthesisSession)
	// Returns a string representation of this construct.
	//
	// Returns: a string representation of this resource.
	// Experimental.
	ToString() *string
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	// Experimental.
	Validate() *[]*string
	// Experimental.
	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.

Example:

// 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"

cfnFlowSource := awscdk.Aws_mediaconnect.NewCfnFlowSource(this, jsii.String("MyCfnFlowSource"), &cfnFlowSourceProps{
	description: jsii.String("description"),
	name: jsii.String("name"),

	// the properties below are optional
	decryption: &encryptionProperty{
		algorithm: jsii.String("algorithm"),
		roleArn: jsii.String("roleArn"),

		// the properties below are optional
		constantInitializationVector: jsii.String("constantInitializationVector"),
		deviceId: jsii.String("deviceId"),
		keyType: jsii.String("keyType"),
		region: jsii.String("region"),
		resourceId: jsii.String("resourceId"),
		secretArn: jsii.String("secretArn"),
		url: jsii.String("url"),
	},
	entitlementArn: jsii.String("entitlementArn"),
	flowArn: jsii.String("flowArn"),
	ingestPort: jsii.Number(123),
	maxBitrate: jsii.Number(123),
	maxLatency: jsii.Number(123),
	protocol: jsii.String("protocol"),
	streamId: jsii.String("streamId"),
	vpcInterfaceName: jsii.String("vpcInterfaceName"),
	whitelistCidr: jsii.String("whitelistCidr"),
})

func NewCfnFlowSource ¶

func NewCfnFlowSource(scope awscdk.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 `field:"required" json:"description" yaml:"description"`
	// The name of the source.
	Name *string `field:"required" json:"name" yaml:"name"`
	// The type of encryption that is used on the content ingested from the source.
	Decryption interface{} `field:"optional" 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 `field:"optional" json:"entitlementArn" yaml:"entitlementArn"`
	// The Amazon Resource Name (ARN) of the flow.
	FlowArn *string `field:"optional" 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 `field:"optional" json:"ingestPort" yaml:"ingestPort"`
	// The maximum bitrate for RIST, RTP, and RTP-FEC streams.
	MaxBitrate *float64 `field:"optional" json:"maxBitrate" yaml:"maxBitrate"`
	// The maximum latency in milliseconds.
	//
	// This parameter applies only to RIST-based, Zixi-based, and Fujitsu-based streams.
	MaxLatency *float64 `field:"optional" json:"maxLatency" yaml:"maxLatency"`
	// The protocol that the source uses to deliver the content to MediaConnect.
	Protocol *string `field:"optional" 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 `field:"optional" json:"streamId" yaml:"streamId"`
	// The name of the VPC interface that you want to send your output to.
	VpcInterfaceName *string `field:"optional" 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 `field:"optional" json:"whitelistCidr" yaml:"whitelistCidr"`
}

Properties for defining a `CfnFlowSource`.

Example:

// 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"

cfnFlowSourceProps := &cfnFlowSourceProps{
	description: jsii.String("description"),
	name: jsii.String("name"),

	// the properties below are optional
	decryption: &encryptionProperty{
		algorithm: jsii.String("algorithm"),
		roleArn: jsii.String("roleArn"),

		// the properties below are optional
		constantInitializationVector: jsii.String("constantInitializationVector"),
		deviceId: jsii.String("deviceId"),
		keyType: jsii.String("keyType"),
		region: jsii.String("region"),
		resourceId: jsii.String("resourceId"),
		secretArn: jsii.String("secretArn"),
		url: jsii.String("url"),
	},
	entitlementArn: jsii.String("entitlementArn"),
	flowArn: jsii.String("flowArn"),
	ingestPort: jsii.Number(123),
	maxBitrate: jsii.Number(123),
	maxLatency: jsii.Number(123),
	protocol: jsii.String("protocol"),
	streamId: jsii.String("streamId"),
	vpcInterfaceName: jsii.String("vpcInterfaceName"),
	whitelistCidr: jsii.String("whitelistCidr"),
}

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 `field:"required" 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 `field:"required" 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 `field:"optional" 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 `field:"optional" 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 `field:"optional" 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 `field:"optional" 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 `field:"optional" json:"resourceId" yaml:"resourceId"`
	// The ARN of the secret that you created in AWS Secrets Manager to store the encryption key.
	SecretArn *string `field:"optional" 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 `field:"optional" json:"url" yaml:"url"`
}

Information about the encryption of the flow.

Example:

// 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"

encryptionProperty := &encryptionProperty{
	algorithm: jsii.String("algorithm"),
	roleArn: jsii.String("roleArn"),

	// the properties below are optional
	constantInitializationVector: jsii.String("constantInitializationVector"),
	deviceId: jsii.String("deviceId"),
	keyType: jsii.String("keyType"),
	region: jsii.String("region"),
	resourceId: jsii.String("resourceId"),
	secretArn: jsii.String("secretArn"),
	url: jsii.String("url"),
}

type CfnFlowVpcInterface ¶

type CfnFlowVpcInterface interface {
	awscdk.CfnResource
	awscdk.IInspectable
	// The IDs of the network interfaces that MediaConnect created in your account.
	AttrNetworkInterfaceIds() *[]*string
	// Options for this resource, such as condition, update policy etc.
	// Experimental.
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	// AWS resource type.
	// Experimental.
	CfnResourceType() *string
	// Returns: the stack trace of the point where this Resource was created from, sourced
	// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
	// node +internal+ entries filtered.
	// Experimental.
	CreationStack() *[]*string
	// The Amazon Resource Name (ARN) of the flow.
	FlowArn() *string
	SetFlowArn(val *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)`.
	//
	// Returns: the logical ID as a stringified token. This value will only get
	// resolved during synthesis.
	// Experimental.
	LogicalId() *string
	// The name of the VPC Interface.
	//
	// This value must be unique within the current flow.
	Name() *string
	SetName(val *string)
	// The construct tree node associated with this construct.
	// Experimental.
	Node() awscdk.ConstructNode
	// 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 })`.
	// Experimental.
	Ref() *string
	// The Amazon Resource Name (ARN) of the role that you created when you set up MediaConnect as a trusted service.
	RoleArn() *string
	SetRoleArn(val *string)
	// 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
	SetSecurityGroupIds(val *[]*string)
	// The stack in which this element is defined.
	//
	// CfnElements must be defined within a stack scope (directly or indirectly).
	// Experimental.
	Stack() awscdk.Stack
	// 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
	SetSubnetId(val *string)
	// Return properties modified after initiation.
	//
	// Resources that expose mutable properties should override this function to
	// collect and return the properties object for this resource.
	// Experimental.
	UpdatedProperites() *map[string]interface{}
	// Syntactic sugar for `addOverride(path, undefined)`.
	// Experimental.
	AddDeletionOverride(path *string)
	// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
	//
	// This can be used for resources across stacks (or nested stack) boundaries
	// and the dependency will automatically be transferred to the relevant scope.
	// Experimental.
	AddDependsOn(target awscdk.CfnResource)
	// Add a value to the CloudFormation Resource Metadata.
	// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
	//
	// Note that this is a different set of metadata from CDK node metadata; this
	// metadata ends up in the stack template under the resource, whereas CDK
	// node metadata ends up in the Cloud Assembly.
	//
	// Experimental.
	AddMetadata(key *string, value interface{})
	// Adds an override to the synthesized CloudFormation resource.
	//
	// 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,
	// “`typescript
	// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
	// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
	// “`
	// would add the overrides
	// “`json
	// "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.
	// Experimental.
	AddOverride(path *string, value interface{})
	// Adds an override that deletes the value of a property from the resource definition.
	// Experimental.
	AddPropertyDeletionOverride(propertyPath *string)
	// Adds an override to a resource property.
	//
	// Syntactic sugar for `addOverride("Properties.<...>", value)`.
	// Experimental.
	AddPropertyOverride(propertyPath *string, value interface{})
	// Sets the deletion policy of the resource based on the removal policy specified.
	//
	// 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`).
	// Experimental.
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	// 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.
	// Experimental.
	GetAtt(attributeName *string) awscdk.Reference
	// Retrieve a value value from the CloudFormation Resource Metadata.
	// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
	//
	// Note that this is a different set of metadata from CDK node metadata; this
	// metadata ends up in the stack template under the resource, whereas CDK
	// node metadata ends up in the Cloud Assembly.
	//
	// Experimental.
	GetMetadata(key *string) interface{}
	// Examines the CloudFormation resource and discloses attributes.
	Inspect(inspector awscdk.TreeInspector)
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	// Experimental.
	OnPrepare()
	// Allows this construct to emit artifacts into the cloud assembly during synthesis.
	//
	// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
	// as they participate in synthesizing the cloud assembly.
	// Experimental.
	OnSynthesize(session constructs.ISynthesisSession)
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	// Experimental.
	OnValidate() *[]*string
	// Overrides the auto-generated logical ID with a specific ID.
	// Experimental.
	OverrideLogicalId(newLogicalId *string)
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	// Experimental.
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
	//
	// Returns: `true` if the resource should be included or `false` is the resource
	// should be omitted.
	// Experimental.
	ShouldSynthesize() *bool
	// Allows this construct to emit artifacts into the cloud assembly during synthesis.
	//
	// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
	// as they participate in synthesizing the cloud assembly.
	// Experimental.
	Synthesize(session awscdk.ISynthesisSession)
	// Returns a string representation of this construct.
	//
	// Returns: a string representation of this resource.
	// Experimental.
	ToString() *string
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	// Experimental.
	Validate() *[]*string
	// Experimental.
	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.

Example:

// 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"

cfnFlowVpcInterface := awscdk.Aws_mediaconnect.NewCfnFlowVpcInterface(this, jsii.String("MyCfnFlowVpcInterface"), &cfnFlowVpcInterfaceProps{
	flowArn: jsii.String("flowArn"),
	name: jsii.String("name"),
	roleArn: jsii.String("roleArn"),
	securityGroupIds: []*string{
		jsii.String("securityGroupIds"),
	},
	subnetId: jsii.String("subnetId"),
})

func NewCfnFlowVpcInterface ¶

func NewCfnFlowVpcInterface(scope awscdk.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 `field:"required" json:"flowArn" yaml:"flowArn"`
	// The name of the VPC Interface.
	//
	// This value must be unique within the current flow.
	Name *string `field:"required" 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 `field:"required" 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 `field:"required" 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 `field:"required" json:"subnetId" yaml:"subnetId"`
}

Properties for defining a `CfnFlowVpcInterface`.

Example:

// 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"

cfnFlowVpcInterfaceProps := &cfnFlowVpcInterfaceProps{
	flowArn: jsii.String("flowArn"),
	name: jsii.String("name"),
	roleArn: jsii.String("roleArn"),
	securityGroupIds: []*string{
		jsii.String("securityGroupIds"),
	},
	subnetId: jsii.String("subnetId"),
}

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 `field:"required" json:"roleArn" yaml:"roleArn"`
	// The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
	Algorithm *string `field:"optional" 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 `field:"optional" 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 `field:"optional" 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 `field:"optional" 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 `field:"optional" 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 `field:"optional" json:"resourceId" yaml:"resourceId"`
	// The ARN of the secret that you created in AWS Secrets Manager to store the encryption key.
	SecretArn *string `field:"optional" 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 `field:"optional" json:"url" yaml:"url"`
}

Information about the encryption of the flow.

Example:

// 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"

encryptionProperty := &encryptionProperty{
	roleArn: jsii.String("roleArn"),

	// the properties below are optional
	algorithm: jsii.String("algorithm"),
	constantInitializationVector: jsii.String("constantInitializationVector"),
	deviceId: jsii.String("deviceId"),
	keyType: jsii.String("keyType"),
	region: jsii.String("region"),
	resourceId: jsii.String("resourceId"),
	secretArn: jsii.String("secretArn"),
	url: jsii.String("url"),
}

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 `field:"optional" 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 `field:"optional" json:"state" yaml:"state"`
}

The settings for source failover.

Example:

// 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"

failoverConfigProperty := &failoverConfigProperty{
	recoveryWindow: jsii.Number(123),
	state: jsii.String("state"),
}

type CfnFlow_SourceProperty ¶

type CfnFlow_SourceProperty struct {
	// The type of encryption that is used on the content ingested from the source.
	Decryption interface{} `field:"optional" json:"decryption" yaml:"decryption"`
	// A description of the source.
	//
	// This description is not visible outside of the current AWS account.
	Description *string `field:"optional" 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 `field:"optional" json:"entitlementArn" yaml:"entitlementArn"`
	// The IP address that the flow listens on for incoming content.
	IngestIp *string `field:"optional" 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 `field:"optional" json:"ingestPort" yaml:"ingestPort"`
	// The maximum bitrate for RIST, RTP, and RTP-FEC streams.
	MaxBitrate *float64 `field:"optional" json:"maxBitrate" yaml:"maxBitrate"`
	// The maximum latency in milliseconds for a RIST or Zixi-based source.
	MaxLatency *float64 `field:"optional" 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 `field:"optional" json:"minLatency" yaml:"minLatency"`
	// The name of the source.
	Name *string `field:"optional" 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 `field:"optional" json:"protocol" yaml:"protocol"`
	// The ARN of the source.
	SourceArn *string `field:"optional" json:"sourceArn" yaml:"sourceArn"`
	// The port that the flow will be listening on for incoming content.
	SourceIngestPort *string `field:"optional" 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 `field:"optional" json:"streamId" yaml:"streamId"`
	// The name of the VPC interface that the source content comes from.
	VpcInterfaceName *string `field:"optional" 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 `field:"optional" 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.

Example:

// 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"

sourceProperty := &sourceProperty{
	decryption: &encryptionProperty{
		roleArn: jsii.String("roleArn"),

		// the properties below are optional
		algorithm: jsii.String("algorithm"),
		constantInitializationVector: jsii.String("constantInitializationVector"),
		deviceId: jsii.String("deviceId"),
		keyType: jsii.String("keyType"),
		region: jsii.String("region"),
		resourceId: jsii.String("resourceId"),
		secretArn: jsii.String("secretArn"),
		url: jsii.String("url"),
	},
	description: jsii.String("description"),
	entitlementArn: jsii.String("entitlementArn"),
	ingestIp: jsii.String("ingestIp"),
	ingestPort: jsii.Number(123),
	maxBitrate: jsii.Number(123),
	maxLatency: jsii.Number(123),
	minLatency: jsii.Number(123),
	name: jsii.String("name"),
	protocol: jsii.String("protocol"),
	sourceArn: jsii.String("sourceArn"),
	sourceIngestPort: jsii.String("sourceIngestPort"),
	streamId: jsii.String("streamId"),
	vpcInterfaceName: jsii.String("vpcInterfaceName"),
	whitelistCidr: jsii.String("whitelistCidr"),
}

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
internal

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