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 CfnBridgeOutput_CFN_RESOURCE_TYPE_NAME() *string
- func CfnBridgeOutput_IsCfnElement(x interface{}) *bool
- func CfnBridgeOutput_IsCfnResource(x interface{}) *bool
- func CfnBridgeOutput_IsConstruct(x interface{}) *bool
- func CfnBridgeSource_CFN_RESOURCE_TYPE_NAME() *string
- func CfnBridgeSource_IsCfnElement(x interface{}) *bool
- func CfnBridgeSource_IsCfnResource(x interface{}) *bool
- func CfnBridgeSource_IsConstruct(x interface{}) *bool
- func CfnBridge_CFN_RESOURCE_TYPE_NAME() *string
- func CfnBridge_IsCfnElement(x interface{}) *bool
- func CfnBridge_IsCfnResource(x interface{}) *bool
- func CfnBridge_IsConstruct(x interface{}) *bool
- func CfnFlowEntitlement_CFN_RESOURCE_TYPE_NAME() *string
- func CfnFlowEntitlement_IsCfnElement(x interface{}) *bool
- func CfnFlowEntitlement_IsCfnResource(x interface{}) *bool
- func CfnFlowEntitlement_IsConstruct(x interface{}) *bool
- func CfnFlowOutput_CFN_RESOURCE_TYPE_NAME() *string
- func CfnFlowOutput_IsCfnElement(x interface{}) *bool
- func CfnFlowOutput_IsCfnResource(x interface{}) *bool
- func CfnFlowOutput_IsConstruct(x interface{}) *bool
- func CfnFlowSource_CFN_RESOURCE_TYPE_NAME() *string
- func CfnFlowSource_IsCfnElement(x interface{}) *bool
- func CfnFlowSource_IsCfnResource(x interface{}) *bool
- func CfnFlowSource_IsConstruct(x interface{}) *bool
- func CfnFlowVpcInterface_CFN_RESOURCE_TYPE_NAME() *string
- func CfnFlowVpcInterface_IsCfnElement(x interface{}) *bool
- func CfnFlowVpcInterface_IsCfnResource(x interface{}) *bool
- func CfnFlowVpcInterface_IsConstruct(x interface{}) *bool
- func CfnFlow_CFN_RESOURCE_TYPE_NAME() *string
- func CfnFlow_IsCfnElement(x interface{}) *bool
- func CfnFlow_IsCfnResource(x interface{}) *bool
- func CfnFlow_IsConstruct(x interface{}) *bool
- func CfnGateway_CFN_RESOURCE_TYPE_NAME() *string
- func CfnGateway_IsCfnElement(x interface{}) *bool
- func CfnGateway_IsCfnResource(x interface{}) *bool
- func CfnGateway_IsConstruct(x interface{}) *bool
- func NewCfnBridgeOutput_Override(c CfnBridgeOutput, scope constructs.Construct, id *string, ...)
- func NewCfnBridgeSource_Override(c CfnBridgeSource, scope constructs.Construct, id *string, ...)
- func NewCfnBridge_Override(c CfnBridge, scope constructs.Construct, id *string, props *CfnBridgeProps)
- func NewCfnFlowEntitlement_Override(c CfnFlowEntitlement, scope constructs.Construct, id *string, ...)
- func NewCfnFlowOutput_Override(c CfnFlowOutput, scope constructs.Construct, id *string, ...)
- func NewCfnFlowSource_Override(c CfnFlowSource, scope constructs.Construct, id *string, ...)
- func NewCfnFlowVpcInterface_Override(c CfnFlowVpcInterface, scope constructs.Construct, id *string, ...)
- func NewCfnFlow_Override(c CfnFlow, scope constructs.Construct, id *string, props *CfnFlowProps)
- func NewCfnGateway_Override(c CfnGateway, scope constructs.Construct, id *string, props *CfnGatewayProps)
- type CfnBridge
- type CfnBridgeOutput
- type CfnBridgeOutputProps
- type CfnBridgeOutput_BridgeNetworkOutputProperty
- type CfnBridgeProps
- type CfnBridgeSource
- type CfnBridgeSourceProps
- type CfnBridgeSource_BridgeFlowSourceProperty
- type CfnBridgeSource_BridgeNetworkSourceProperty
- type CfnBridgeSource_VpcInterfaceAttachmentProperty
- type CfnBridge_BridgeFlowSourceProperty
- type CfnBridge_BridgeNetworkOutputProperty
- type CfnBridge_BridgeNetworkSourceProperty
- type CfnBridge_BridgeOutputProperty
- type CfnBridge_BridgeSourceProperty
- type CfnBridge_EgressGatewayBridgeProperty
- type CfnBridge_FailoverConfigProperty
- type CfnBridge_IngressGatewayBridgeProperty
- type CfnBridge_SourcePriorityProperty
- type CfnBridge_VpcInterfaceAttachmentProperty
- type CfnFlow
- type CfnFlowEntitlement
- type CfnFlowEntitlementProps
- type CfnFlowEntitlement_EncryptionProperty
- type CfnFlowOutput
- type CfnFlowOutputProps
- type CfnFlowOutput_EncryptionProperty
- type CfnFlowOutput_VpcInterfaceAttachmentProperty
- type CfnFlowProps
- type CfnFlowSource
- type CfnFlowSourceProps
- type CfnFlowSource_EncryptionProperty
- type CfnFlowSource_GatewayBridgeSourceProperty
- type CfnFlowSource_VpcInterfaceAttachmentProperty
- type CfnFlowVpcInterface
- type CfnFlowVpcInterfaceProps
- type CfnFlow_EncryptionProperty
- type CfnFlow_FailoverConfigProperty
- type CfnFlow_GatewayBridgeSourceProperty
- type CfnFlow_SourcePriorityProperty
- type CfnFlow_SourceProperty
- type CfnFlow_VpcInterfaceAttachmentProperty
- type CfnGateway
- type CfnGatewayProps
- type CfnGateway_GatewayNetworkProperty
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CfnBridgeOutput_CFN_RESOURCE_TYPE_NAME ¶ added in v2.85.0
func CfnBridgeOutput_CFN_RESOURCE_TYPE_NAME() *string
func CfnBridgeOutput_IsCfnElement ¶ added in v2.85.0
func CfnBridgeOutput_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnBridgeOutput_IsCfnResource ¶ added in v2.85.0
func CfnBridgeOutput_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnBridgeOutput_IsConstruct ¶ added in v2.85.0
func CfnBridgeOutput_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnBridgeSource_CFN_RESOURCE_TYPE_NAME ¶ added in v2.85.0
func CfnBridgeSource_CFN_RESOURCE_TYPE_NAME() *string
func CfnBridgeSource_IsCfnElement ¶ added in v2.85.0
func CfnBridgeSource_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnBridgeSource_IsCfnResource ¶ added in v2.85.0
func CfnBridgeSource_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnBridgeSource_IsConstruct ¶ added in v2.85.0
func CfnBridgeSource_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnBridge_CFN_RESOURCE_TYPE_NAME ¶ added in v2.85.0
func CfnBridge_CFN_RESOURCE_TYPE_NAME() *string
func CfnBridge_IsCfnElement ¶ added in v2.85.0
func CfnBridge_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnBridge_IsCfnResource ¶ added in v2.85.0
func CfnBridge_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnBridge_IsConstruct ¶ added in v2.85.0
func CfnBridge_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnFlowEntitlement_CFN_RESOURCE_TYPE_NAME ¶
func CfnFlowEntitlement_CFN_RESOURCE_TYPE_NAME() *string
func CfnFlowEntitlement_IsCfnElement ¶
func CfnFlowEntitlement_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnFlowEntitlement_IsCfnResource ¶
func CfnFlowEntitlement_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnFlowEntitlement_IsConstruct ¶
func CfnFlowEntitlement_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnFlowOutput_CFN_RESOURCE_TYPE_NAME ¶
func CfnFlowOutput_CFN_RESOURCE_TYPE_NAME() *string
func CfnFlowOutput_IsCfnElement ¶
func CfnFlowOutput_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnFlowOutput_IsCfnResource ¶
func CfnFlowOutput_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnFlowOutput_IsConstruct ¶
func CfnFlowOutput_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnFlowSource_CFN_RESOURCE_TYPE_NAME ¶
func CfnFlowSource_CFN_RESOURCE_TYPE_NAME() *string
func CfnFlowSource_IsCfnElement ¶
func CfnFlowSource_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnFlowSource_IsCfnResource ¶
func CfnFlowSource_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnFlowSource_IsConstruct ¶
func CfnFlowSource_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnFlowVpcInterface_CFN_RESOURCE_TYPE_NAME ¶
func CfnFlowVpcInterface_CFN_RESOURCE_TYPE_NAME() *string
func CfnFlowVpcInterface_IsCfnElement ¶
func CfnFlowVpcInterface_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnFlowVpcInterface_IsCfnResource ¶
func CfnFlowVpcInterface_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnFlowVpcInterface_IsConstruct ¶
func CfnFlowVpcInterface_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnFlow_CFN_RESOURCE_TYPE_NAME ¶
func CfnFlow_CFN_RESOURCE_TYPE_NAME() *string
func CfnFlow_IsCfnElement ¶
func CfnFlow_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnFlow_IsCfnResource ¶
func CfnFlow_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnFlow_IsConstruct ¶
func CfnFlow_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnGateway_CFN_RESOURCE_TYPE_NAME ¶ added in v2.85.0
func CfnGateway_CFN_RESOURCE_TYPE_NAME() *string
func CfnGateway_IsCfnElement ¶ added in v2.85.0
func CfnGateway_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnGateway_IsCfnResource ¶ added in v2.85.0
func CfnGateway_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnGateway_IsConstruct ¶ added in v2.85.0
func CfnGateway_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func NewCfnBridgeOutput_Override ¶ added in v2.85.0
func NewCfnBridgeOutput_Override(c CfnBridgeOutput, scope constructs.Construct, id *string, props *CfnBridgeOutputProps)
func NewCfnBridgeSource_Override ¶ added in v2.85.0
func NewCfnBridgeSource_Override(c CfnBridgeSource, scope constructs.Construct, id *string, props *CfnBridgeSourceProps)
func NewCfnBridge_Override ¶ added in v2.85.0
func NewCfnBridge_Override(c CfnBridge, scope constructs.Construct, id *string, props *CfnBridgeProps)
func NewCfnFlowEntitlement_Override ¶
func NewCfnFlowEntitlement_Override(c CfnFlowEntitlement, scope constructs.Construct, id *string, props *CfnFlowEntitlementProps)
func NewCfnFlowOutput_Override ¶
func NewCfnFlowOutput_Override(c CfnFlowOutput, scope constructs.Construct, id *string, props *CfnFlowOutputProps)
func NewCfnFlowSource_Override ¶
func NewCfnFlowSource_Override(c CfnFlowSource, scope constructs.Construct, id *string, props *CfnFlowSourceProps)
func NewCfnFlowVpcInterface_Override ¶
func NewCfnFlowVpcInterface_Override(c CfnFlowVpcInterface, scope constructs.Construct, id *string, props *CfnFlowVpcInterfaceProps)
func NewCfnFlow_Override ¶
func NewCfnFlow_Override(c CfnFlow, scope constructs.Construct, id *string, props *CfnFlowProps)
func NewCfnGateway_Override ¶ added in v2.85.0
func NewCfnGateway_Override(c CfnGateway, scope constructs.Construct, id *string, props *CfnGatewayProps)
Types ¶
type CfnBridge ¶ added in v2.85.0
type CfnBridge interface {
awscdk.CfnResource
awscdk.IInspectable
// The Amazon Resource Name (ARN) of the bridge.
AttrBridgeArn() *string
// The current status of the bridge.
//
// Possible values are: ACTIVE or STANDBY.
AttrBridgeState() *string
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
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.
CreationStack() *[]*string
// Create a bridge with the egress bridge type.
EgressGatewayBridge() interface{}
SetEgressGatewayBridge(val interface{})
// Create a bridge with the ingress bridge type.
IngressGatewayBridge() interface{}
SetIngressGatewayBridge(val interface{})
// 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.
LogicalId() *string
// The name of the bridge.
Name() *string
SetName(val *string)
// The tree node.
Node() constructs.Node
// The outputs that you want to add to this bridge.
Outputs() interface{}
SetOutputs(val interface{})
// The bridge placement Amazon Resource Number (ARN).
PlacementArn() *string
SetPlacementArn(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 })`.
Ref() *string
// The settings for source failover.
SourceFailoverConfig() interface{}
SetSourceFailoverConfig(val interface{})
// The sources that you want to add to this bridge.
Sources() interface{}
SetSources(val interface{})
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// Deprecated.
// Deprecated: use `updatedProperties`
//
// Return properties modified after initiation
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
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.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
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.
//
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.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
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`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
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.
GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) 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.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// 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.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
}
The AWS::MediaConnect::Bridge resource defines a connection between your data center’s gateway instances and the cloud.
For each bridge, you specify the type of bridge, transport protocol to use, and details for any outputs and 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"
cfnBridge := awscdk.Aws_mediaconnect.NewCfnBridge(this, jsii.String("MyCfnBridge"), &CfnBridgeProps{
Name: jsii.String("name"),
PlacementArn: jsii.String("placementArn"),
Sources: []interface{}{
&BridgeSourceProperty{
FlowSource: &BridgeFlowSourceProperty{
FlowArn: jsii.String("flowArn"),
Name: jsii.String("name"),
// the properties below are optional
FlowVpcInterfaceAttachment: &VpcInterfaceAttachmentProperty{
VpcInterfaceName: jsii.String("vpcInterfaceName"),
},
},
NetworkSource: &BridgeNetworkSourceProperty{
MulticastIp: jsii.String("multicastIp"),
Name: jsii.String("name"),
NetworkName: jsii.String("networkName"),
Port: jsii.Number(123),
Protocol: jsii.String("protocol"),
},
},
},
// the properties below are optional
EgressGatewayBridge: &EgressGatewayBridgeProperty{
MaxBitrate: jsii.Number(123),
},
IngressGatewayBridge: &IngressGatewayBridgeProperty{
MaxBitrate: jsii.Number(123),
MaxOutputs: jsii.Number(123),
},
Outputs: []interface{}{
&BridgeOutputProperty{
NetworkOutput: &BridgeNetworkOutputProperty{
IpAddress: jsii.String("ipAddress"),
Name: jsii.String("name"),
NetworkName: jsii.String("networkName"),
Port: jsii.Number(123),
Protocol: jsii.String("protocol"),
Ttl: jsii.Number(123),
},
},
},
SourceFailoverConfig: &FailoverConfigProperty{
FailoverMode: jsii.String("failoverMode"),
// the properties below are optional
SourcePriority: &SourcePriorityProperty{
PrimarySource: jsii.String("primarySource"),
},
State: jsii.String("state"),
},
})
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-bridge.html
func NewCfnBridge ¶ added in v2.85.0
func NewCfnBridge(scope constructs.Construct, id *string, props *CfnBridgeProps) CfnBridge
type CfnBridgeOutput ¶ added in v2.85.0
type CfnBridgeOutput interface {
awscdk.CfnResource
awscdk.IInspectable
// The ARN of the bridge that you want to describe.
BridgeArn() *string
SetBridgeArn(val *string)
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
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.
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.
LogicalId() *string
// The network output name.
Name() *string
SetName(val *string)
// Add a network output to an existing bridge.
NetworkOutput() interface{}
SetNetworkOutput(val interface{})
// The tree node.
Node() constructs.Node
// 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 })`.
Ref() *string
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// Deprecated.
// Deprecated: use `updatedProperties`
//
// Return properties modified after initiation
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
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.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
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.
//
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.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
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`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
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.
GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) 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.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// 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.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
}
Adds outputs to an existing bridge.
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"
cfnBridgeOutput := awscdk.Aws_mediaconnect.NewCfnBridgeOutput(this, jsii.String("MyCfnBridgeOutput"), &CfnBridgeOutputProps{
BridgeArn: jsii.String("bridgeArn"),
Name: jsii.String("name"),
NetworkOutput: &BridgeNetworkOutputProperty{
IpAddress: jsii.String("ipAddress"),
NetworkName: jsii.String("networkName"),
Port: jsii.Number(123),
Protocol: jsii.String("protocol"),
Ttl: jsii.Number(123),
},
})
func NewCfnBridgeOutput ¶ added in v2.85.0
func NewCfnBridgeOutput(scope constructs.Construct, id *string, props *CfnBridgeOutputProps) CfnBridgeOutput
type CfnBridgeOutputProps ¶ added in v2.85.0
type CfnBridgeOutputProps struct {
// The ARN of the bridge that you want to describe.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-bridgeoutput.html#cfn-mediaconnect-bridgeoutput-bridgearn
//
BridgeArn *string `field:"required" json:"bridgeArn" yaml:"bridgeArn"`
// The network output name.
//
// This name is used to reference the output and must be unique among outputs in this bridge.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-bridgeoutput.html#cfn-mediaconnect-bridgeoutput-name
//
Name *string `field:"required" json:"name" yaml:"name"`
// Add a network output to an existing bridge.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-bridgeoutput.html#cfn-mediaconnect-bridgeoutput-networkoutput
//
NetworkOutput interface{} `field:"required" json:"networkOutput" yaml:"networkOutput"`
}
Properties for defining a `CfnBridgeOutput`.
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"
cfnBridgeOutputProps := &CfnBridgeOutputProps{
BridgeArn: jsii.String("bridgeArn"),
Name: jsii.String("name"),
NetworkOutput: &BridgeNetworkOutputProperty{
IpAddress: jsii.String("ipAddress"),
NetworkName: jsii.String("networkName"),
Port: jsii.Number(123),
Protocol: jsii.String("protocol"),
Ttl: jsii.Number(123),
},
}
type CfnBridgeOutput_BridgeNetworkOutputProperty ¶ added in v2.85.0
type CfnBridgeOutput_BridgeNetworkOutputProperty struct {
// The network output IP Address.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-bridgeoutput-bridgenetworkoutput.html#cfn-mediaconnect-bridgeoutput-bridgenetworkoutput-ipaddress
//
IpAddress *string `field:"required" json:"ipAddress" yaml:"ipAddress"`
// The network output's gateway network name.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-bridgeoutput-bridgenetworkoutput.html#cfn-mediaconnect-bridgeoutput-bridgenetworkoutput-networkname
//
NetworkName *string `field:"required" json:"networkName" yaml:"networkName"`
// The network output port.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-bridgeoutput-bridgenetworkoutput.html#cfn-mediaconnect-bridgeoutput-bridgenetworkoutput-port
//
Port *float64 `field:"required" json:"port" yaml:"port"`
// The network output protocol.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-bridgeoutput-bridgenetworkoutput.html#cfn-mediaconnect-bridgeoutput-bridgenetworkoutput-protocol
//
Protocol *string `field:"required" json:"protocol" yaml:"protocol"`
// The network output TTL.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-bridgeoutput-bridgenetworkoutput.html#cfn-mediaconnect-bridgeoutput-bridgenetworkoutput-ttl
//
Ttl *float64 `field:"required" json:"ttl" yaml:"ttl"`
}
The output of the bridge.
A network output is delivered to your premises.
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"
bridgeNetworkOutputProperty := &BridgeNetworkOutputProperty{
IpAddress: jsii.String("ipAddress"),
NetworkName: jsii.String("networkName"),
Port: jsii.Number(123),
Protocol: jsii.String("protocol"),
Ttl: jsii.Number(123),
}
type CfnBridgeProps ¶ added in v2.85.0
type CfnBridgeProps struct {
// The name of the bridge.
//
// This name can not be modified after the bridge is created.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-bridge.html#cfn-mediaconnect-bridge-name
//
Name *string `field:"required" json:"name" yaml:"name"`
// The bridge placement Amazon Resource Number (ARN).
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-bridge.html#cfn-mediaconnect-bridge-placementarn
//
PlacementArn *string `field:"required" json:"placementArn" yaml:"placementArn"`
// The sources that you want to add to this bridge.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-bridge.html#cfn-mediaconnect-bridge-sources
//
Sources interface{} `field:"required" json:"sources" yaml:"sources"`
// Create a bridge with the egress bridge type.
//
// An egress bridge is a cloud-to-ground bridge. The content comes from an existing MediaConnect flow and is delivered to your premises.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-bridge.html#cfn-mediaconnect-bridge-egressgatewaybridge
//
EgressGatewayBridge interface{} `field:"optional" json:"egressGatewayBridge" yaml:"egressGatewayBridge"`
// Create a bridge with the ingress bridge type.
//
// An ingress bridge is a ground-to-cloud bridge. The content originates at your premises and is delivered to the cloud.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-bridge.html#cfn-mediaconnect-bridge-ingressgatewaybridge
//
IngressGatewayBridge interface{} `field:"optional" json:"ingressGatewayBridge" yaml:"ingressGatewayBridge"`
// The outputs that you want to add to this bridge.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-bridge.html#cfn-mediaconnect-bridge-outputs
//
Outputs interface{} `field:"optional" json:"outputs" yaml:"outputs"`
// The settings for source failover.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-bridge.html#cfn-mediaconnect-bridge-sourcefailoverconfig
//
SourceFailoverConfig interface{} `field:"optional" json:"sourceFailoverConfig" yaml:"sourceFailoverConfig"`
}
Properties for defining a `CfnBridge`.
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"
cfnBridgeProps := &CfnBridgeProps{
Name: jsii.String("name"),
PlacementArn: jsii.String("placementArn"),
Sources: []interface{}{
&BridgeSourceProperty{
FlowSource: &BridgeFlowSourceProperty{
FlowArn: jsii.String("flowArn"),
Name: jsii.String("name"),
// the properties below are optional
FlowVpcInterfaceAttachment: &VpcInterfaceAttachmentProperty{
VpcInterfaceName: jsii.String("vpcInterfaceName"),
},
},
NetworkSource: &BridgeNetworkSourceProperty{
MulticastIp: jsii.String("multicastIp"),
Name: jsii.String("name"),
NetworkName: jsii.String("networkName"),
Port: jsii.Number(123),
Protocol: jsii.String("protocol"),
},
},
},
// the properties below are optional
EgressGatewayBridge: &EgressGatewayBridgeProperty{
MaxBitrate: jsii.Number(123),
},
IngressGatewayBridge: &IngressGatewayBridgeProperty{
MaxBitrate: jsii.Number(123),
MaxOutputs: jsii.Number(123),
},
Outputs: []interface{}{
&BridgeOutputProperty{
NetworkOutput: &BridgeNetworkOutputProperty{
IpAddress: jsii.String("ipAddress"),
Name: jsii.String("name"),
NetworkName: jsii.String("networkName"),
Port: jsii.Number(123),
Protocol: jsii.String("protocol"),
Ttl: jsii.Number(123),
},
},
},
SourceFailoverConfig: &FailoverConfigProperty{
FailoverMode: jsii.String("failoverMode"),
// the properties below are optional
SourcePriority: &SourcePriorityProperty{
PrimarySource: jsii.String("primarySource"),
},
State: jsii.String("state"),
},
}
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-bridge.html
type CfnBridgeSource ¶ added in v2.85.0
type CfnBridgeSource interface {
awscdk.CfnResource
awscdk.IInspectable
// The ARN of the bridge that you want to describe.
BridgeArn() *string
SetBridgeArn(val *string)
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
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.
CreationStack() *[]*string
// Add a flow source to an existing bridge.
FlowSource() interface{}
SetFlowSource(val interface{})
// 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.
LogicalId() *string
// The name of the flow source.
Name() *string
SetName(val *string)
// Add a network source to an existing bridge.
NetworkSource() interface{}
SetNetworkSource(val interface{})
// The tree node.
Node() constructs.Node
// 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 })`.
Ref() *string
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// Deprecated.
// Deprecated: use `updatedProperties`
//
// Return properties modified after initiation
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
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.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
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.
//
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.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
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`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
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.
GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) 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.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// 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.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
}
Adds sources to an existing bridge.
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"
cfnBridgeSource := awscdk.Aws_mediaconnect.NewCfnBridgeSource(this, jsii.String("MyCfnBridgeSource"), &CfnBridgeSourceProps{
BridgeArn: jsii.String("bridgeArn"),
Name: jsii.String("name"),
// the properties below are optional
FlowSource: &BridgeFlowSourceProperty{
FlowArn: jsii.String("flowArn"),
// the properties below are optional
FlowVpcInterfaceAttachment: &VpcInterfaceAttachmentProperty{
VpcInterfaceName: jsii.String("vpcInterfaceName"),
},
},
NetworkSource: &BridgeNetworkSourceProperty{
MulticastIp: jsii.String("multicastIp"),
NetworkName: jsii.String("networkName"),
Port: jsii.Number(123),
Protocol: jsii.String("protocol"),
},
})
func NewCfnBridgeSource ¶ added in v2.85.0
func NewCfnBridgeSource(scope constructs.Construct, id *string, props *CfnBridgeSourceProps) CfnBridgeSource
type CfnBridgeSourceProps ¶ added in v2.85.0
type CfnBridgeSourceProps struct {
// The ARN of the bridge that you want to describe.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-bridgesource.html#cfn-mediaconnect-bridgesource-bridgearn
//
BridgeArn *string `field:"required" json:"bridgeArn" yaml:"bridgeArn"`
// The name of the flow source.
//
// This name is used to reference the source and must be unique among sources in this bridge.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-bridgesource.html#cfn-mediaconnect-bridgesource-name
//
Name *string `field:"required" json:"name" yaml:"name"`
// Add a flow source to an existing bridge.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-bridgesource.html#cfn-mediaconnect-bridgesource-flowsource
//
FlowSource interface{} `field:"optional" json:"flowSource" yaml:"flowSource"`
// Add a network source to an existing bridge.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-bridgesource.html#cfn-mediaconnect-bridgesource-networksource
//
NetworkSource interface{} `field:"optional" json:"networkSource" yaml:"networkSource"`
}
Properties for defining a `CfnBridgeSource`.
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"
cfnBridgeSourceProps := &CfnBridgeSourceProps{
BridgeArn: jsii.String("bridgeArn"),
Name: jsii.String("name"),
// the properties below are optional
FlowSource: &BridgeFlowSourceProperty{
FlowArn: jsii.String("flowArn"),
// the properties below are optional
FlowVpcInterfaceAttachment: &VpcInterfaceAttachmentProperty{
VpcInterfaceName: jsii.String("vpcInterfaceName"),
},
},
NetworkSource: &BridgeNetworkSourceProperty{
MulticastIp: jsii.String("multicastIp"),
NetworkName: jsii.String("networkName"),
Port: jsii.Number(123),
Protocol: jsii.String("protocol"),
},
}
type CfnBridgeSource_BridgeFlowSourceProperty ¶ added in v2.85.0
type CfnBridgeSource_BridgeFlowSourceProperty struct {
// The ARN of the cloud flow used as a source of this bridge.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-bridgesource-bridgeflowsource.html#cfn-mediaconnect-bridgesource-bridgeflowsource-flowarn
//
FlowArn *string `field:"required" json:"flowArn" yaml:"flowArn"`
// The name of the VPC interface attachment to use for this source.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-bridgesource-bridgeflowsource.html#cfn-mediaconnect-bridgesource-bridgeflowsource-flowvpcinterfaceattachment
//
FlowVpcInterfaceAttachment interface{} `field:"optional" json:"flowVpcInterfaceAttachment" yaml:"flowVpcInterfaceAttachment"`
}
The source of the bridge.
A flow source originates in MediaConnect as an existing cloud 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"
bridgeFlowSourceProperty := &BridgeFlowSourceProperty{
FlowArn: jsii.String("flowArn"),
// the properties below are optional
FlowVpcInterfaceAttachment: &VpcInterfaceAttachmentProperty{
VpcInterfaceName: jsii.String("vpcInterfaceName"),
},
}
type CfnBridgeSource_BridgeNetworkSourceProperty ¶ added in v2.85.0
type CfnBridgeSource_BridgeNetworkSourceProperty struct {
// The network source multicast IP.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-bridgesource-bridgenetworksource.html#cfn-mediaconnect-bridgesource-bridgenetworksource-multicastip
//
MulticastIp *string `field:"required" json:"multicastIp" yaml:"multicastIp"`
// The network source's gateway network name.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-bridgesource-bridgenetworksource.html#cfn-mediaconnect-bridgesource-bridgenetworksource-networkname
//
NetworkName *string `field:"required" json:"networkName" yaml:"networkName"`
// The network source port.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-bridgesource-bridgenetworksource.html#cfn-mediaconnect-bridgesource-bridgenetworksource-port
//
Port *float64 `field:"required" json:"port" yaml:"port"`
// The network source protocol.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-bridgesource-bridgenetworksource.html#cfn-mediaconnect-bridgesource-bridgenetworksource-protocol
//
Protocol *string `field:"required" json:"protocol" yaml:"protocol"`
}
The source of the bridge.
A network source originates at your premises.
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"
bridgeNetworkSourceProperty := &BridgeNetworkSourceProperty{
MulticastIp: jsii.String("multicastIp"),
NetworkName: jsii.String("networkName"),
Port: jsii.Number(123),
Protocol: jsii.String("protocol"),
}
type CfnBridgeSource_VpcInterfaceAttachmentProperty ¶ added in v2.85.0
type CfnBridgeSource_VpcInterfaceAttachmentProperty struct {
// The name of the VPC interface that you want to send your output to.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-bridgesource-vpcinterfaceattachment.html#cfn-mediaconnect-bridgesource-vpcinterfaceattachment-vpcinterfacename
//
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 CfnBridge_BridgeFlowSourceProperty ¶ added in v2.85.0
type CfnBridge_BridgeFlowSourceProperty struct {
// The ARN of the cloud flow used as a source of this bridge.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-bridge-bridgeflowsource.html#cfn-mediaconnect-bridge-bridgeflowsource-flowarn
//
FlowArn *string `field:"required" json:"flowArn" yaml:"flowArn"`
// The name of the flow source.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-bridge-bridgeflowsource.html#cfn-mediaconnect-bridge-bridgeflowsource-name
//
Name *string `field:"required" json:"name" yaml:"name"`
// The name of the VPC interface attachment to use for this source.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-bridge-bridgeflowsource.html#cfn-mediaconnect-bridge-bridgeflowsource-flowvpcinterfaceattachment
//
FlowVpcInterfaceAttachment interface{} `field:"optional" json:"flowVpcInterfaceAttachment" yaml:"flowVpcInterfaceAttachment"`
}
The source of the bridge.
A flow source originates in MediaConnect as an existing cloud 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"
bridgeFlowSourceProperty := &BridgeFlowSourceProperty{
FlowArn: jsii.String("flowArn"),
Name: jsii.String("name"),
// the properties below are optional
FlowVpcInterfaceAttachment: &VpcInterfaceAttachmentProperty{
VpcInterfaceName: jsii.String("vpcInterfaceName"),
},
}
type CfnBridge_BridgeNetworkOutputProperty ¶ added in v2.85.0
type CfnBridge_BridgeNetworkOutputProperty struct {
// The network output IP Address.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-bridge-bridgenetworkoutput.html#cfn-mediaconnect-bridge-bridgenetworkoutput-ipaddress
//
IpAddress *string `field:"required" json:"ipAddress" yaml:"ipAddress"`
// The network output name.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-bridge-bridgenetworkoutput.html#cfn-mediaconnect-bridge-bridgenetworkoutput-name
//
Name *string `field:"required" json:"name" yaml:"name"`
// The network output's gateway network name.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-bridge-bridgenetworkoutput.html#cfn-mediaconnect-bridge-bridgenetworkoutput-networkname
//
NetworkName *string `field:"required" json:"networkName" yaml:"networkName"`
// The network output port.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-bridge-bridgenetworkoutput.html#cfn-mediaconnect-bridge-bridgenetworkoutput-port
//
Port *float64 `field:"required" json:"port" yaml:"port"`
// The network output protocol.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-bridge-bridgenetworkoutput.html#cfn-mediaconnect-bridge-bridgenetworkoutput-protocol
//
Protocol *string `field:"required" json:"protocol" yaml:"protocol"`
// The network output TTL.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-bridge-bridgenetworkoutput.html#cfn-mediaconnect-bridge-bridgenetworkoutput-ttl
//
Ttl *float64 `field:"required" json:"ttl" yaml:"ttl"`
}
The output of the bridge.
A network output is delivered to your premises.
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"
bridgeNetworkOutputProperty := &BridgeNetworkOutputProperty{
IpAddress: jsii.String("ipAddress"),
Name: jsii.String("name"),
NetworkName: jsii.String("networkName"),
Port: jsii.Number(123),
Protocol: jsii.String("protocol"),
Ttl: jsii.Number(123),
}
type CfnBridge_BridgeNetworkSourceProperty ¶ added in v2.85.0
type CfnBridge_BridgeNetworkSourceProperty struct {
// The network source multicast IP.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-bridge-bridgenetworksource.html#cfn-mediaconnect-bridge-bridgenetworksource-multicastip
//
MulticastIp *string `field:"required" json:"multicastIp" yaml:"multicastIp"`
// The name of the network source.
//
// This name is used to reference the source and must be unique among sources in this bridge.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-bridge-bridgenetworksource.html#cfn-mediaconnect-bridge-bridgenetworksource-name
//
Name *string `field:"required" json:"name" yaml:"name"`
// The network source's gateway network name.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-bridge-bridgenetworksource.html#cfn-mediaconnect-bridge-bridgenetworksource-networkname
//
NetworkName *string `field:"required" json:"networkName" yaml:"networkName"`
// The network source port.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-bridge-bridgenetworksource.html#cfn-mediaconnect-bridge-bridgenetworksource-port
//
Port *float64 `field:"required" json:"port" yaml:"port"`
// The network source protocol.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-bridge-bridgenetworksource.html#cfn-mediaconnect-bridge-bridgenetworksource-protocol
//
Protocol *string `field:"required" json:"protocol" yaml:"protocol"`
}
The source of the bridge.
A network source originates at your premises.
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"
bridgeNetworkSourceProperty := &BridgeNetworkSourceProperty{
MulticastIp: jsii.String("multicastIp"),
Name: jsii.String("name"),
NetworkName: jsii.String("networkName"),
Port: jsii.Number(123),
Protocol: jsii.String("protocol"),
}
type CfnBridge_BridgeOutputProperty ¶ added in v2.85.0
type CfnBridge_BridgeOutputProperty struct {
// The output of the bridge.
//
// A network output is delivered to your premises.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-bridge-bridgeoutput.html#cfn-mediaconnect-bridge-bridgeoutput-networkoutput
//
NetworkOutput interface{} `field:"optional" json:"networkOutput" yaml:"networkOutput"`
}
The output of the bridge.
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"
bridgeOutputProperty := &BridgeOutputProperty{
NetworkOutput: &BridgeNetworkOutputProperty{
IpAddress: jsii.String("ipAddress"),
Name: jsii.String("name"),
NetworkName: jsii.String("networkName"),
Port: jsii.Number(123),
Protocol: jsii.String("protocol"),
Ttl: jsii.Number(123),
},
}
type CfnBridge_BridgeSourceProperty ¶ added in v2.85.0
type CfnBridge_BridgeSourceProperty struct {
// The source of the bridge.
//
// A flow source originates in MediaConnect as an existing cloud flow.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-bridge-bridgesource.html#cfn-mediaconnect-bridge-bridgesource-flowsource
//
FlowSource interface{} `field:"optional" json:"flowSource" yaml:"flowSource"`
// The source of the bridge.
//
// A network source originates at your premises.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-bridge-bridgesource.html#cfn-mediaconnect-bridge-bridgesource-networksource
//
NetworkSource interface{} `field:"optional" json:"networkSource" yaml:"networkSource"`
}
The bridge's 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"
bridgeSourceProperty := &BridgeSourceProperty{
FlowSource: &BridgeFlowSourceProperty{
FlowArn: jsii.String("flowArn"),
Name: jsii.String("name"),
// the properties below are optional
FlowVpcInterfaceAttachment: &VpcInterfaceAttachmentProperty{
VpcInterfaceName: jsii.String("vpcInterfaceName"),
},
},
NetworkSource: &BridgeNetworkSourceProperty{
MulticastIp: jsii.String("multicastIp"),
Name: jsii.String("name"),
NetworkName: jsii.String("networkName"),
Port: jsii.Number(123),
Protocol: jsii.String("protocol"),
},
}
type CfnBridge_EgressGatewayBridgeProperty ¶ added in v2.85.0
type CfnBridge_EgressGatewayBridgeProperty struct {
// The maximum expected bitrate (in bps) of the egress bridge.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-bridge-egressgatewaybridge.html#cfn-mediaconnect-bridge-egressgatewaybridge-maxbitrate
//
MaxBitrate *float64 `field:"required" json:"maxBitrate" yaml:"maxBitrate"`
}
Create a bridge with the egress bridge type.
An egress bridge is a cloud-to-ground bridge. The content comes from an existing MediaConnect flow and is delivered to your premises.
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"
egressGatewayBridgeProperty := &EgressGatewayBridgeProperty{
MaxBitrate: jsii.Number(123),
}
type CfnBridge_FailoverConfigProperty ¶ added in v2.85.0
type CfnBridge_FailoverConfigProperty struct {
// The type of failover you choose for this flow.
//
// MERGE combines the source streams into a single stream, allowing graceful recovery from any single-source loss. FAILOVER allows switching between different streams.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-bridge-failoverconfig.html#cfn-mediaconnect-bridge-failoverconfig-failovermode
//
FailoverMode *string `field:"required" json:"failoverMode" yaml:"failoverMode"`
// The priority you want to assign to a source.
//
// You can have a primary stream and a backup stream or two equally prioritized streams. This setting only applies when Failover Mode is set to FAILOVER.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-bridge-failoverconfig.html#cfn-mediaconnect-bridge-failoverconfig-sourcepriority
//
SourcePriority interface{} `field:"optional" json:"sourcePriority" yaml:"sourcePriority"`
// The state of source failover on the flow.
//
// If the state is inactive, the flow can have only one source. If the state is active, the flow can have one or two sources.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-bridge-failoverconfig.html#cfn-mediaconnect-bridge-failoverconfig-state
//
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{
FailoverMode: jsii.String("failoverMode"),
// the properties below are optional
SourcePriority: &SourcePriorityProperty{
PrimarySource: jsii.String("primarySource"),
},
State: jsii.String("state"),
}
type CfnBridge_IngressGatewayBridgeProperty ¶ added in v2.85.0
type CfnBridge_IngressGatewayBridgeProperty struct {
// The maximum expected bitrate (in bps) of the ingress bridge.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-bridge-ingressgatewaybridge.html#cfn-mediaconnect-bridge-ingressgatewaybridge-maxbitrate
//
MaxBitrate *float64 `field:"required" json:"maxBitrate" yaml:"maxBitrate"`
// The maximum number of outputs on the ingress bridge.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-bridge-ingressgatewaybridge.html#cfn-mediaconnect-bridge-ingressgatewaybridge-maxoutputs
//
MaxOutputs *float64 `field:"required" json:"maxOutputs" yaml:"maxOutputs"`
}
Create a bridge with the ingress bridge type.
An ingress bridge is a ground-to-cloud bridge. The content originates at your premises and is delivered to the cloud.
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"
ingressGatewayBridgeProperty := &IngressGatewayBridgeProperty{
MaxBitrate: jsii.Number(123),
MaxOutputs: jsii.Number(123),
}
type CfnBridge_SourcePriorityProperty ¶ added in v2.85.0
type CfnBridge_SourcePriorityProperty struct {
// The name of the source you choose as the primary source for this flow.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-bridge-sourcepriority.html#cfn-mediaconnect-bridge-sourcepriority-primarysource
//
PrimarySource *string `field:"optional" json:"primarySource" yaml:"primarySource"`
}
The priority you want to assign to a source.
You can have a primary stream and a backup stream or two equally prioritized streams. This setting only applies when Failover Mode is set to 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"
sourcePriorityProperty := &SourcePriorityProperty{
PrimarySource: jsii.String("primarySource"),
}
type CfnBridge_VpcInterfaceAttachmentProperty ¶ added in v2.85.0
type CfnBridge_VpcInterfaceAttachmentProperty struct {
// The name of the VPC interface that you want to send your output to.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-bridge-vpcinterfaceattachment.html#cfn-mediaconnect-bridge-vpcinterfaceattachment-vpcinterfacename
//
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 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 will be listening 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.(ReadOnly).
AttrSourceSourceIngestPort() *string
// The Availability Zone that you want to create the flow in.
AvailabilityZone() *string
SetAvailabilityZone(val *string)
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
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.
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.
LogicalId() *string
// The name of the flow.
Name() *string
SetName(val *string)
// The tree node.
Node() constructs.Node
// 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 })`.
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).
Stack() awscdk.Stack
// Deprecated.
// Deprecated: use `updatedProperties`
//
// Return properties modified after initiation
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
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.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
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.
//
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.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
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`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
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.
GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) 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.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// 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.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
}
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"),
GatewayBridgeSource: &GatewayBridgeSourceProperty{
BridgeArn: jsii.String("bridgeArn"),
// the properties below are optional
VpcInterfaceAttachment: &VpcInterfaceAttachmentProperty{
VpcInterfaceName: jsii.String("vpcInterfaceName"),
},
},
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"),
SenderControlPort: jsii.Number(123),
SenderIpAddress: jsii.String("senderIpAddress"),
SourceArn: jsii.String("sourceArn"),
SourceIngestPort: jsii.String("sourceIngestPort"),
SourceListenerAddress: jsii.String("sourceListenerAddress"),
SourceListenerPort: jsii.Number(123),
StreamId: jsii.String("streamId"),
VpcInterfaceName: jsii.String("vpcInterfaceName"),
WhitelistCidr: jsii.String("whitelistCidr"),
},
// the properties below are optional
AvailabilityZone: jsii.String("availabilityZone"),
SourceFailoverConfig: &FailoverConfigProperty{
FailoverMode: jsii.String("failoverMode"),
RecoveryWindow: jsii.Number(123),
SourcePriority: &SourcePriorityProperty{
PrimarySource: jsii.String("primarySource"),
},
State: jsii.String("state"),
},
})
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flow.html
func NewCfnFlow ¶
func NewCfnFlow(scope constructs.Construct, id *string, props *CfnFlowProps) CfnFlow
type CfnFlowEntitlement ¶
type CfnFlowEntitlement interface {
awscdk.CfnResource
awscdk.IInspectable
// The entitlement ARN.
AttrEntitlementArn() *string
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
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.
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.
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.
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.
LogicalId() *string
// The name of the entitlement.
Name() *string
SetName(val *string)
// The tree node.
Node() constructs.Node
// 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 })`.
Ref() *string
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// The AWS account IDs that you want to share your content with.
Subscribers() *[]*string
SetSubscribers(val *[]*string)
// Deprecated.
// Deprecated: use `updatedProperties`
//
// Return properties modified after initiation
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
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.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
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.
//
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.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
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`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
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.
GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) 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.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// 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.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
}
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 constructs.Construct, id *string, props *CfnFlowEntitlementProps) CfnFlowEntitlement
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.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowentitlement.html#cfn-mediaconnect-flowentitlement-description
//
Description *string `field:"required" json:"description" yaml:"description"`
// The Amazon Resource Name (ARN) of the flow.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowentitlement.html#cfn-mediaconnect-flowentitlement-flowarn
//
FlowArn *string `field:"required" json:"flowArn" yaml:"flowArn"`
// The name of the entitlement.
//
// This value must be unique within the current flow.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowentitlement.html#cfn-mediaconnect-flowentitlement-name
//
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.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowentitlement.html#cfn-mediaconnect-flowentitlement-subscribers
//
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.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowentitlement.html#cfn-mediaconnect-flowentitlement-datatransfersubscriberfeepercent
//
// Default: - 0.
//
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.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowentitlement.html#cfn-mediaconnect-flowentitlement-encryption
//
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.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowentitlement.html#cfn-mediaconnect-flowentitlement-entitlementstatus
//
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 static key encryption (such as aes128, aes192, or aes256).
//
// If you are using SPEKE or SRT-password encryption, this property must be left blank.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flowentitlement-encryption.html#cfn-mediaconnect-flowentitlement-encryption-algorithm
//
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).
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flowentitlement-encryption.html#cfn-mediaconnect-flowentitlement-encryption-rolearn
//
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.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flowentitlement-encryption.html#cfn-mediaconnect-flowentitlement-encryption-constantinitializationvector
//
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.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flowentitlement-encryption.html#cfn-mediaconnect-flowentitlement-encryption-deviceid
//
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` ). Valid key types are: `static-key` , `speke` , and `srt-password` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flowentitlement-encryption.html#cfn-mediaconnect-flowentitlement-encryption-keytype
//
// Default: - "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.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flowentitlement-encryption.html#cfn-mediaconnect-flowentitlement-encryption-region
//
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.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flowentitlement-encryption.html#cfn-mediaconnect-flowentitlement-encryption-resourceid
//
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.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flowentitlement-encryption.html#cfn-mediaconnect-flowentitlement-encryption-secretarn
//
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.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flowentitlement-encryption.html#cfn-mediaconnect-flowentitlement-encryption-url
//
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.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
// The range of IP addresses that are allowed to initiate output requests to this flow.
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.
CreationStack() *[]*string
// A description of the output.
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 this output is attached to.
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.
LogicalId() *string
// The maximum latency in milliseconds.
MaxLatency() *float64
SetMaxLatency(val *float64)
// The minimum latency in milliseconds for SRT-based streams.
MinLatency() *float64
SetMinLatency(val *float64)
// The name of the output.
Name() *string
SetName(val *string)
// The tree node.
Node() constructs.Node
// 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 })`.
Ref() *string
// The identifier that is assigned to the Zixi receiver.
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).
Stack() awscdk.Stack
// The stream ID that you want to use for this transport.
StreamId() *string
SetStreamId(val *string)
// Deprecated.
// Deprecated: use `updatedProperties`
//
// Return properties modified after initiation
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *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)`.
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.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
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.
//
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.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
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`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
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.
GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) 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.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// 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.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
}
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. The following protocols are supported: RIST, RTP, RTP-FEC, SRT-listener, SRT-caller, Zixi pull, Zixi push, and Fujitsu-QoS. CDI and ST 2110 JPEG XS protocols are not currently supported by AWS CloudFormation.
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 constructs.Construct, id *string, props *CfnFlowOutputProps) CfnFlowOutput
type CfnFlowOutputProps ¶
type CfnFlowOutputProps struct {
// The Amazon Resource Name (ARN) of the flow this output is attached to.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowoutput.html#cfn-mediaconnect-flowoutput-flowarn
//
FlowArn *string `field:"required" json:"flowArn" yaml:"flowArn"`
// The protocol to use for the output.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowoutput.html#cfn-mediaconnect-flowoutput-protocol
//
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.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowoutput.html#cfn-mediaconnect-flowoutput-cidrallowlist
//
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.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowoutput.html#cfn-mediaconnect-flowoutput-description
//
Description *string `field:"optional" json:"description" yaml:"description"`
// The IP address where you want to send the output.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowoutput.html#cfn-mediaconnect-flowoutput-destination
//
Destination *string `field:"optional" json:"destination" yaml:"destination"`
// The encryption credentials that you want to use for the output.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowoutput.html#cfn-mediaconnect-flowoutput-encryption
//
Encryption interface{} `field:"optional" json:"encryption" yaml:"encryption"`
// The maximum latency in milliseconds.
//
// This parameter applies only to RIST-based, Zixi-based, and Fujitsu-based streams.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowoutput.html#cfn-mediaconnect-flowoutput-maxlatency
//
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.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowoutput.html#cfn-mediaconnect-flowoutput-minlatency
//
MinLatency *float64 `field:"optional" json:"minLatency" yaml:"minLatency"`
// The name of the output.
//
// This value must be unique within the current flow.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowoutput.html#cfn-mediaconnect-flowoutput-name
//
Name *string `field:"optional" json:"name" yaml:"name"`
// The port to use when MediaConnect distributes content to the output.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowoutput.html#cfn-mediaconnect-flowoutput-port
//
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.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowoutput.html#cfn-mediaconnect-flowoutput-remoteid
//
RemoteId *string `field:"optional" json:"remoteId" yaml:"remoteId"`
// The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowoutput.html#cfn-mediaconnect-flowoutput-smoothinglatency
//
SmoothingLatency *float64 `field:"optional" json:"smoothingLatency" yaml:"smoothingLatency"`
// The stream ID that you want to use for this transport.
//
// This parameter applies only to Zixi and SRT caller-based streams.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowoutput.html#cfn-mediaconnect-flowoutput-streamid
//
StreamId *string `field:"optional" json:"streamId" yaml:"streamId"`
// The VPC interface that you want to send your output to.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowoutput.html#cfn-mediaconnect-flowoutput-vpcinterfaceattachment
//
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).
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flowoutput-encryption.html#cfn-mediaconnect-flowoutput-encryption-rolearn
//
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.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flowoutput-encryption.html#cfn-mediaconnect-flowoutput-encryption-secretarn
//
SecretArn *string `field:"required" json:"secretArn" yaml:"secretArn"`
// The type of algorithm that is used for static key encryption (such as aes128, aes192, or aes256).
//
// If you are using SPEKE or SRT-password encryption, this property must be left blank.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flowoutput-encryption.html#cfn-mediaconnect-flowoutput-encryption-algorithm
//
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` ). Valid key types are: `static-key` , `speke` , and `srt-password` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flowoutput-encryption.html#cfn-mediaconnect-flowoutput-encryption-keytype
//
// Default: - "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.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flowoutput-vpcinterfaceattachment.html#cfn-mediaconnect-flowoutput-vpcinterfaceattachment-vpcinterfacename
//
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.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flow.html#cfn-mediaconnect-flow-name
//
Name *string `field:"required" json:"name" yaml:"name"`
// The settings for the source that you want to use for the new flow.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flow.html#cfn-mediaconnect-flow-source
//
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.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flow.html#cfn-mediaconnect-flow-availabilityzone
//
AvailabilityZone *string `field:"optional" json:"availabilityZone" yaml:"availabilityZone"`
// The settings for source failover.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flow.html#cfn-mediaconnect-flow-sourcefailoverconfig
//
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"),
GatewayBridgeSource: &GatewayBridgeSourceProperty{
BridgeArn: jsii.String("bridgeArn"),
// the properties below are optional
VpcInterfaceAttachment: &VpcInterfaceAttachmentProperty{
VpcInterfaceName: jsii.String("vpcInterfaceName"),
},
},
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"),
SenderControlPort: jsii.Number(123),
SenderIpAddress: jsii.String("senderIpAddress"),
SourceArn: jsii.String("sourceArn"),
SourceIngestPort: jsii.String("sourceIngestPort"),
SourceListenerAddress: jsii.String("sourceListenerAddress"),
SourceListenerPort: jsii.Number(123),
StreamId: jsii.String("streamId"),
VpcInterfaceName: jsii.String("vpcInterfaceName"),
WhitelistCidr: jsii.String("whitelistCidr"),
},
// the properties below are optional
AvailabilityZone: jsii.String("availabilityZone"),
SourceFailoverConfig: &FailoverConfigProperty{
FailoverMode: jsii.String("failoverMode"),
RecoveryWindow: jsii.Number(123),
SourcePriority: &SourcePriorityProperty{
PrimarySource: jsii.String("primarySource"),
},
State: jsii.String("state"),
},
}
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flow.html
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
// 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.
AttrSourceIngestPort() *string
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
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.
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.
Description() *string
SetDescription(val *string)
// The ARN of the entitlement that allows you to subscribe to the flow.
EntitlementArn() *string
SetEntitlementArn(val *string)
// The Amazon Resource Name (ARN) of the flow this source is connected to.
FlowArn() *string
SetFlowArn(val *string)
// The source configuration for cloud flows receiving a stream from a bridge.
GatewayBridgeSource() interface{}
SetGatewayBridgeSource(val interface{})
// The port that the flow listens on for incoming content.
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.
LogicalId() *string
// The maximum bitrate for RIST, RTP, and RTP-FEC streams.
MaxBitrate() *float64
SetMaxBitrate(val *float64)
// The maximum latency in milliseconds.
MaxLatency() *float64
SetMaxLatency(val *float64)
// The minimum latency in milliseconds for SRT-based streams.
MinLatency() *float64
SetMinLatency(val *float64)
// The name of the source.
Name() *string
SetName(val *string)
// The tree node.
Node() constructs.Node
// 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 })`.
Ref() *string
// The port that the flow uses to send outbound requests to initiate connection with the sender.
SenderControlPort() *float64
SetSenderControlPort(val *float64)
// The IP address that the flow communicates with to initiate connection with the sender.
SenderIpAddress() *string
SetSenderIpAddress(val *string)
// Source IP or domain name for SRT-caller protocol.
SourceListenerAddress() *string
SetSourceListenerAddress(val *string)
// Source port for SRT-caller protocol.
SourceListenerPort() *float64
SetSourceListenerPort(val *float64)
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// The stream ID that you want to use for this transport.
StreamId() *string
SetStreamId(val *string)
// Deprecated.
// Deprecated: use `updatedProperties`
//
// Return properties modified after initiation
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *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.
WhitelistCidr() *string
SetWhitelistCidr(val *string)
// Syntactic sugar for `addOverride(path, undefined)`.
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.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
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.
//
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.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
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`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
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.
GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) 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.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// 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.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
}
The AWS::MediaConnect::FlowSource resource is used to add additional sources to an existing flow.
Adding an additional source requires Failover to be enabled. When you enable Failover, the additional source must use the same protocol as the existing source. A source 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.
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{
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"),
},
EntitlementArn: jsii.String("entitlementArn"),
FlowArn: jsii.String("flowArn"),
GatewayBridgeSource: &GatewayBridgeSourceProperty{
BridgeArn: jsii.String("bridgeArn"),
// the properties below are optional
VpcInterfaceAttachment: &VpcInterfaceAttachmentProperty{
VpcInterfaceName: jsii.String("vpcInterfaceName"),
},
},
IngestPort: jsii.Number(123),
MaxBitrate: jsii.Number(123),
MaxLatency: jsii.Number(123),
MinLatency: jsii.Number(123),
Protocol: jsii.String("protocol"),
SenderControlPort: jsii.Number(123),
SenderIpAddress: jsii.String("senderIpAddress"),
SourceListenerAddress: jsii.String("sourceListenerAddress"),
SourceListenerPort: jsii.Number(123),
StreamId: jsii.String("streamId"),
VpcInterfaceName: jsii.String("vpcInterfaceName"),
WhitelistCidr: jsii.String("whitelistCidr"),
})
func NewCfnFlowSource ¶
func NewCfnFlowSource(scope constructs.Construct, id *string, props *CfnFlowSourceProps) CfnFlowSource
type CfnFlowSourceProps ¶
type CfnFlowSourceProps struct {
// A description of the source.
//
// This description is not visible outside of the current AWS account.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowsource.html#cfn-mediaconnect-flowsource-description
//
Description *string `field:"required" json:"description" yaml:"description"`
// The name of the source.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowsource.html#cfn-mediaconnect-flowsource-name
//
Name *string `field:"required" json:"name" yaml:"name"`
// The type of encryption that is used on the content ingested from the source.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowsource.html#cfn-mediaconnect-flowsource-decryption
//
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.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowsource.html#cfn-mediaconnect-flowsource-entitlementarn
//
EntitlementArn *string `field:"optional" json:"entitlementArn" yaml:"entitlementArn"`
// The Amazon Resource Name (ARN) of the flow this source is connected to.
//
// The flow must have Failover enabled to add an additional source.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowsource.html#cfn-mediaconnect-flowsource-flowarn
//
FlowArn *string `field:"optional" json:"flowArn" yaml:"flowArn"`
// The source configuration for cloud flows receiving a stream from a bridge.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowsource.html#cfn-mediaconnect-flowsource-gatewaybridgesource
//
GatewayBridgeSource interface{} `field:"optional" json:"gatewayBridgeSource" yaml:"gatewayBridgeSource"`
// 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.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowsource.html#cfn-mediaconnect-flowsource-ingestport
//
IngestPort *float64 `field:"optional" json:"ingestPort" yaml:"ingestPort"`
// The maximum bitrate for RIST, RTP, and RTP-FEC streams.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowsource.html#cfn-mediaconnect-flowsource-maxbitrate
//
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.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowsource.html#cfn-mediaconnect-flowsource-maxlatency
//
// Default: - 2000.
//
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.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowsource.html#cfn-mediaconnect-flowsource-minlatency
//
// Default: - 2000.
//
MinLatency *float64 `field:"optional" json:"minLatency" yaml:"minLatency"`
// The protocol that the source uses to deliver the content to MediaConnect.
//
// Adding additional sources to an existing flow requires Failover to be enabled. When you enable Failover, the additional source must use the same protocol as the existing source. Only the following protocols support failover: Zixi-push, RTP-FEC, RTP, RIST and SRT protocols.
//
// If you use failover with SRT caller or listener, the `FailoverMode` property must be set to `FAILOVER` . The `FailoverMode` property is found in the `FailoverConfig` resource of the same flow ARN you used for the source's `FlowArn` property. SRT caller/listener does not support merge mode failover.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowsource.html#cfn-mediaconnect-flowsource-protocol
//
Protocol *string `field:"optional" json:"protocol" yaml:"protocol"`
// The port that the flow uses to send outbound requests to initiate connection with the sender.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowsource.html#cfn-mediaconnect-flowsource-sendercontrolport
//
SenderControlPort *float64 `field:"optional" json:"senderControlPort" yaml:"senderControlPort"`
// The IP address that the flow communicates with to initiate connection with the sender.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowsource.html#cfn-mediaconnect-flowsource-senderipaddress
//
SenderIpAddress *string `field:"optional" json:"senderIpAddress" yaml:"senderIpAddress"`
// Source IP or domain name for SRT-caller protocol.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowsource.html#cfn-mediaconnect-flowsource-sourcelisteneraddress
//
SourceListenerAddress *string `field:"optional" json:"sourceListenerAddress" yaml:"sourceListenerAddress"`
// Source port for SRT-caller protocol.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowsource.html#cfn-mediaconnect-flowsource-sourcelistenerport
//
SourceListenerPort *float64 `field:"optional" json:"sourceListenerPort" yaml:"sourceListenerPort"`
// The stream ID that you want to use for this transport.
//
// This parameter applies only to Zixi and SRT caller-based streams.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowsource.html#cfn-mediaconnect-flowsource-streamid
//
StreamId *string `field:"optional" json:"streamId" yaml:"streamId"`
// The name of the VPC interface that you want to send your output to.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowsource.html#cfn-mediaconnect-flowsource-vpcinterfacename
//
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.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowsource.html#cfn-mediaconnect-flowsource-whitelistcidr
//
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{
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"),
},
EntitlementArn: jsii.String("entitlementArn"),
FlowArn: jsii.String("flowArn"),
GatewayBridgeSource: &GatewayBridgeSourceProperty{
BridgeArn: jsii.String("bridgeArn"),
// the properties below are optional
VpcInterfaceAttachment: &VpcInterfaceAttachmentProperty{
VpcInterfaceName: jsii.String("vpcInterfaceName"),
},
},
IngestPort: jsii.Number(123),
MaxBitrate: jsii.Number(123),
MaxLatency: jsii.Number(123),
MinLatency: jsii.Number(123),
Protocol: jsii.String("protocol"),
SenderControlPort: jsii.Number(123),
SenderIpAddress: jsii.String("senderIpAddress"),
SourceListenerAddress: jsii.String("sourceListenerAddress"),
SourceListenerPort: jsii.Number(123),
StreamId: jsii.String("streamId"),
VpcInterfaceName: jsii.String("vpcInterfaceName"),
WhitelistCidr: jsii.String("whitelistCidr"),
}
type CfnFlowSource_EncryptionProperty ¶
type CfnFlowSource_EncryptionProperty struct {
// The Amazon Resource Name (ARN) of the role that you created during setup (when you set up MediaConnect as a trusted entity).
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flowsource-encryption.html#cfn-mediaconnect-flowsource-encryption-rolearn
//
RoleArn *string `field:"required" json:"roleArn" yaml:"roleArn"`
// The type of algorithm that is used for static key encryption (such as aes128, aes192, or aes256).
//
// If you are using SPEKE or SRT-password encryption, this property must be left blank.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flowsource-encryption.html#cfn-mediaconnect-flowsource-encryption-algorithm
//
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.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flowsource-encryption.html#cfn-mediaconnect-flowsource-encryption-constantinitializationvector
//
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.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flowsource-encryption.html#cfn-mediaconnect-flowsource-encryption-deviceid
//
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` ). Valid key types are: `static-key` , `speke` , and `srt-password` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flowsource-encryption.html#cfn-mediaconnect-flowsource-encryption-keytype
//
// Default: - "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.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flowsource-encryption.html#cfn-mediaconnect-flowsource-encryption-region
//
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.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flowsource-encryption.html#cfn-mediaconnect-flowsource-encryption-resourceid
//
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.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flowsource-encryption.html#cfn-mediaconnect-flowsource-encryption-secretarn
//
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.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flowsource-encryption.html#cfn-mediaconnect-flowsource-encryption-url
//
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 CfnFlowSource_GatewayBridgeSourceProperty ¶ added in v2.86.0
type CfnFlowSource_GatewayBridgeSourceProperty struct {
// The ARN of the bridge feeding this flow.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flowsource-gatewaybridgesource.html#cfn-mediaconnect-flowsource-gatewaybridgesource-bridgearn
//
BridgeArn *string `field:"required" json:"bridgeArn" yaml:"bridgeArn"`
// The name of the VPC interface attachment to use for this bridge source.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flowsource-gatewaybridgesource.html#cfn-mediaconnect-flowsource-gatewaybridgesource-vpcinterfaceattachment
//
VpcInterfaceAttachment interface{} `field:"optional" json:"vpcInterfaceAttachment" yaml:"vpcInterfaceAttachment"`
}
The source configuration for cloud flows receiving a stream from a bridge.
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"
gatewayBridgeSourceProperty := &GatewayBridgeSourceProperty{
BridgeArn: jsii.String("bridgeArn"),
// the properties below are optional
VpcInterfaceAttachment: &VpcInterfaceAttachmentProperty{
VpcInterfaceName: jsii.String("vpcInterfaceName"),
},
}
type CfnFlowSource_VpcInterfaceAttachmentProperty ¶ added in v2.86.0
type CfnFlowSource_VpcInterfaceAttachmentProperty struct {
// The name of the VPC interface that you want to send your output to.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flowsource-vpcinterfaceattachment.html#cfn-mediaconnect-flowsource-vpcinterfaceattachment-vpcinterfacename
//
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 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.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
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.
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.
LogicalId() *string
// The name of the VPC Interface.
Name() *string
SetName(val *string)
// The tree node.
Node() constructs.Node
// 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 })`.
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.
SecurityGroupIds() *[]*string
SetSecurityGroupIds(val *[]*string)
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// The subnet IDs that you want to use for your VPC interface.
SubnetId() *string
SetSubnetId(val *string)
// Deprecated.
// Deprecated: use `updatedProperties`
//
// Return properties modified after initiation
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
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.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
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.
//
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.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
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`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
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.
GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) 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.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// 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.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
}
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 constructs.Construct, id *string, props *CfnFlowVpcInterfaceProps) CfnFlowVpcInterface
type CfnFlowVpcInterfaceProps ¶
type CfnFlowVpcInterfaceProps struct {
// The Amazon Resource Name (ARN) of the flow.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowvpcinterface.html#cfn-mediaconnect-flowvpcinterface-flowarn
//
FlowArn *string `field:"required" json:"flowArn" yaml:"flowArn"`
// The name of the VPC Interface.
//
// This value must be unique within the current flow.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowvpcinterface.html#cfn-mediaconnect-flowvpcinterface-name
//
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.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowvpcinterface.html#cfn-mediaconnect-flowvpcinterface-rolearn
//
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.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowvpcinterface.html#cfn-mediaconnect-flowvpcinterface-securitygroupids
//
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.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowvpcinterface.html#cfn-mediaconnect-flowvpcinterface-subnetid
//
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).
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flow-encryption.html#cfn-mediaconnect-flow-encryption-rolearn
//
RoleArn *string `field:"required" json:"roleArn" yaml:"roleArn"`
// The type of algorithm that is used for static key encryption (such as aes128, aes192, or aes256).
//
// If you are using SPEKE or SRT-password encryption, this property must be left blank.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flow-encryption.html#cfn-mediaconnect-flow-encryption-algorithm
//
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.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flow-encryption.html#cfn-mediaconnect-flow-encryption-constantinitializationvector
//
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.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flow-encryption.html#cfn-mediaconnect-flow-encryption-deviceid
//
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` ). Valid key types are: `static-key` , `speke` , and `srt-password` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flow-encryption.html#cfn-mediaconnect-flow-encryption-keytype
//
// Default: - "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.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flow-encryption.html#cfn-mediaconnect-flow-encryption-region
//
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.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flow-encryption.html#cfn-mediaconnect-flow-encryption-resourceid
//
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.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flow-encryption.html#cfn-mediaconnect-flow-encryption-secretarn
//
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.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flow-encryption.html#cfn-mediaconnect-flow-encryption-url
//
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 type of failover you choose for this flow.
//
// MERGE combines the source streams into a single stream, allowing graceful recovery from any single-source loss. FAILOVER allows switching between different streams. The string for this property must be entered as MERGE or FAILOVER. No other string entry is valid.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flow-failoverconfig.html#cfn-mediaconnect-flow-failoverconfig-failovermode
//
FailoverMode *string `field:"optional" json:"failoverMode" yaml:"failoverMode"`
// 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. You can choose a value from 100-500 ms. If you keep this field blank, the service uses the default value of 200 ms. This setting only applies when Failover Mode is set to MERGE.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flow-failoverconfig.html#cfn-mediaconnect-flow-failoverconfig-recoverywindow
//
RecoveryWindow *float64 `field:"optional" json:"recoveryWindow" yaml:"recoveryWindow"`
// The priority you want to assign to a source.
//
// You can have a primary stream and a backup stream or two equally prioritized streams. This setting only applies when Failover Mode is set to FAILOVER.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flow-failoverconfig.html#cfn-mediaconnect-flow-failoverconfig-sourcepriority
//
SourcePriority interface{} `field:"optional" json:"sourcePriority" yaml:"sourcePriority"`
// The state of source failover on the flow.
//
// If the state is inactive, the flow can have only one source. If the state is active, the flow can have one or two sources.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flow-failoverconfig.html#cfn-mediaconnect-flow-failoverconfig-state
//
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{
FailoverMode: jsii.String("failoverMode"),
RecoveryWindow: jsii.Number(123),
SourcePriority: &SourcePriorityProperty{
PrimarySource: jsii.String("primarySource"),
},
State: jsii.String("state"),
}
type CfnFlow_GatewayBridgeSourceProperty ¶ added in v2.86.0
type CfnFlow_GatewayBridgeSourceProperty struct {
// The ARN of the bridge feeding this flow.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flow-gatewaybridgesource.html#cfn-mediaconnect-flow-gatewaybridgesource-bridgearn
//
BridgeArn *string `field:"required" json:"bridgeArn" yaml:"bridgeArn"`
// The name of the VPC interface attachment to use for this bridge source.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flow-gatewaybridgesource.html#cfn-mediaconnect-flow-gatewaybridgesource-vpcinterfaceattachment
//
VpcInterfaceAttachment interface{} `field:"optional" json:"vpcInterfaceAttachment" yaml:"vpcInterfaceAttachment"`
}
The source configuration for cloud flows receiving a stream from a bridge.
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"
gatewayBridgeSourceProperty := &GatewayBridgeSourceProperty{
BridgeArn: jsii.String("bridgeArn"),
// the properties below are optional
VpcInterfaceAttachment: &VpcInterfaceAttachmentProperty{
VpcInterfaceName: jsii.String("vpcInterfaceName"),
},
}
type CfnFlow_SourcePriorityProperty ¶ added in v2.55.0
type CfnFlow_SourcePriorityProperty struct {
// The name of the source you choose as the primary source for this flow.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flow-sourcepriority.html#cfn-mediaconnect-flow-sourcepriority-primarysource
//
PrimarySource *string `field:"required" json:"primarySource" yaml:"primarySource"`
}
The priority you want to assign to a source.
You can have a primary stream and a backup stream or two equally prioritized streams. This setting only applies when Failover Mode is set to 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"
sourcePriorityProperty := &SourcePriorityProperty{
PrimarySource: jsii.String("primarySource"),
}
type CfnFlow_SourceProperty ¶
type CfnFlow_SourceProperty struct {
// The type of encryption that is used on the content ingested from the source.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flow-source.html#cfn-mediaconnect-flow-source-decryption
//
Decryption interface{} `field:"optional" json:"decryption" yaml:"decryption"`
// A description of the source.
//
// This description is not visible outside of the current AWS account.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flow-source.html#cfn-mediaconnect-flow-source-description
//
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.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flow-source.html#cfn-mediaconnect-flow-source-entitlementarn
//
EntitlementArn *string `field:"optional" json:"entitlementArn" yaml:"entitlementArn"`
// The source configuration for cloud flows receiving a stream from a bridge.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flow-source.html#cfn-mediaconnect-flow-source-gatewaybridgesource
//
GatewayBridgeSource interface{} `field:"optional" json:"gatewayBridgeSource" yaml:"gatewayBridgeSource"`
// The IP address that the flow listens on for incoming content.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flow-source.html#cfn-mediaconnect-flow-source-ingestip
//
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.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flow-source.html#cfn-mediaconnect-flow-source-ingestport
//
IngestPort *float64 `field:"optional" json:"ingestPort" yaml:"ingestPort"`
// The maximum bitrate for RIST, RTP, and RTP-FEC streams.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flow-source.html#cfn-mediaconnect-flow-source-maxbitrate
//
MaxBitrate *float64 `field:"optional" json:"maxBitrate" yaml:"maxBitrate"`
// The maximum latency in milliseconds for a RIST or Zixi-based source.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flow-source.html#cfn-mediaconnect-flow-source-maxlatency
//
// Default: - 2000.
//
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.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flow-source.html#cfn-mediaconnect-flow-source-minlatency
//
// Default: - 2000.
//
MinLatency *float64 `field:"optional" json:"minLatency" yaml:"minLatency"`
// The name of the source.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flow-source.html#cfn-mediaconnect-flow-source-name
//
Name *string `field:"optional" json:"name" yaml:"name"`
// The protocol that is used by the source.
//
// AWS CloudFormation does not currently support CDI or ST 2110 JPEG XS source protocols.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flow-source.html#cfn-mediaconnect-flow-source-protocol
//
Protocol *string `field:"optional" json:"protocol" yaml:"protocol"`
// The port that the flow uses to send outbound requests to initiate connection with the sender.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flow-source.html#cfn-mediaconnect-flow-source-sendercontrolport
//
SenderControlPort *float64 `field:"optional" json:"senderControlPort" yaml:"senderControlPort"`
// The IP address that the flow communicates with to initiate connection with the sender.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flow-source.html#cfn-mediaconnect-flow-source-senderipaddress
//
SenderIpAddress *string `field:"optional" json:"senderIpAddress" yaml:"senderIpAddress"`
// The ARN of the source.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flow-source.html#cfn-mediaconnect-flow-source-sourcearn
//
SourceArn *string `field:"optional" json:"sourceArn" yaml:"sourceArn"`
// 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.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flow-source.html#cfn-mediaconnect-flow-source-sourceingestport
//
SourceIngestPort *string `field:"optional" json:"sourceIngestPort" yaml:"sourceIngestPort"`
// Source IP or domain name for SRT-caller protocol.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flow-source.html#cfn-mediaconnect-flow-source-sourcelisteneraddress
//
SourceListenerAddress *string `field:"optional" json:"sourceListenerAddress" yaml:"sourceListenerAddress"`
// Source port for SRT-caller protocol.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flow-source.html#cfn-mediaconnect-flow-source-sourcelistenerport
//
SourceListenerPort *float64 `field:"optional" json:"sourceListenerPort" yaml:"sourceListenerPort"`
// The stream ID that you want to use for the transport.
//
// This parameter applies only to Zixi-based streams.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flow-source.html#cfn-mediaconnect-flow-source-streamid
//
StreamId *string `field:"optional" json:"streamId" yaml:"streamId"`
// The name of the VPC interface that the source content comes from.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flow-source.html#cfn-mediaconnect-flow-source-vpcinterfacename
//
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.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flow-source.html#cfn-mediaconnect-flow-source-whitelistcidr
//
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"),
GatewayBridgeSource: &GatewayBridgeSourceProperty{
BridgeArn: jsii.String("bridgeArn"),
// the properties below are optional
VpcInterfaceAttachment: &VpcInterfaceAttachmentProperty{
VpcInterfaceName: jsii.String("vpcInterfaceName"),
},
},
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"),
SenderControlPort: jsii.Number(123),
SenderIpAddress: jsii.String("senderIpAddress"),
SourceArn: jsii.String("sourceArn"),
SourceIngestPort: jsii.String("sourceIngestPort"),
SourceListenerAddress: jsii.String("sourceListenerAddress"),
SourceListenerPort: jsii.Number(123),
StreamId: jsii.String("streamId"),
VpcInterfaceName: jsii.String("vpcInterfaceName"),
WhitelistCidr: jsii.String("whitelistCidr"),
}
type CfnFlow_VpcInterfaceAttachmentProperty ¶ added in v2.86.0
type CfnFlow_VpcInterfaceAttachmentProperty struct {
// The name of the VPC interface that you want to send your output to.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flow-vpcinterfaceattachment.html#cfn-mediaconnect-flow-vpcinterfaceattachment-vpcinterfacename
//
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 CfnGateway ¶ added in v2.85.0
type CfnGateway interface {
awscdk.CfnResource
awscdk.IInspectable
// The Amazon Resource Name (ARN) of the gateway.
AttrGatewayArn() *string
// The current state of the gateway.
//
// Possible values are: CREATING, ACTIVE, UPDATING, ERROR, DELETING, DELETED.
AttrGatewayState() *string
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
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.
CreationStack() *[]*string
// The range of IP addresses that are allowed to contribute content or initiate output requests for flows communicating with this gateway.
EgressCidrBlocks() *[]*string
SetEgressCidrBlocks(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.
LogicalId() *string
// The name of the network.
Name() *string
SetName(val *string)
// The list of networks that you want to add.
Networks() interface{}
SetNetworks(val interface{})
// The tree node.
Node() constructs.Node
// 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 })`.
Ref() *string
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// Deprecated.
// Deprecated: use `updatedProperties`
//
// Return properties modified after initiation
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
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.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
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.
//
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.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
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`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
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.
GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) 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.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// 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.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
}
The AWS::MediaConnect::Gateway resource is used to create a new gateway.
AWS Elemental MediaConnect Gateway is a feature of MediaConnect that allows the deployment of on-premises resources for transporting live video to and from the AWS Cloud. MediaConnect Gateway allows you to contribute live video to the AWS Cloud from on-premises hardware, as well as distribute live video from the AWS Cloud to your local data center.
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"
cfnGateway := awscdk.Aws_mediaconnect.NewCfnGateway(this, jsii.String("MyCfnGateway"), &CfnGatewayProps{
EgressCidrBlocks: []*string{
jsii.String("egressCidrBlocks"),
},
Name: jsii.String("name"),
Networks: []interface{}{
&GatewayNetworkProperty{
CidrBlock: jsii.String("cidrBlock"),
Name: jsii.String("name"),
},
},
})
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-gateway.html
func NewCfnGateway ¶ added in v2.85.0
func NewCfnGateway(scope constructs.Construct, id *string, props *CfnGatewayProps) CfnGateway
type CfnGatewayProps ¶ added in v2.85.0
type CfnGatewayProps struct {
// The range of IP addresses that are allowed to contribute content or initiate output requests for flows communicating with this gateway.
//
// These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-gateway.html#cfn-mediaconnect-gateway-egresscidrblocks
//
EgressCidrBlocks *[]*string `field:"required" json:"egressCidrBlocks" yaml:"egressCidrBlocks"`
// The name of the network.
//
// This name is used to reference the network and must be unique among networks in this gateway.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-gateway.html#cfn-mediaconnect-gateway-name
//
Name *string `field:"required" json:"name" yaml:"name"`
// The list of networks that you want to add.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-gateway.html#cfn-mediaconnect-gateway-networks
//
Networks interface{} `field:"required" json:"networks" yaml:"networks"`
}
Properties for defining a `CfnGateway`.
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"
cfnGatewayProps := &CfnGatewayProps{
EgressCidrBlocks: []*string{
jsii.String("egressCidrBlocks"),
},
Name: jsii.String("name"),
Networks: []interface{}{
&GatewayNetworkProperty{
CidrBlock: jsii.String("cidrBlock"),
Name: jsii.String("name"),
},
},
}
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-gateway.html
type CfnGateway_GatewayNetworkProperty ¶ added in v2.85.0
type CfnGateway_GatewayNetworkProperty struct {
// A unique IP address range to use for this network.
//
// These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-gateway-gatewaynetwork.html#cfn-mediaconnect-gateway-gatewaynetwork-cidrblock
//
CidrBlock *string `field:"required" json:"cidrBlock" yaml:"cidrBlock"`
// The name of the network.
//
// This name is used to reference the network and must be unique among networks in this gateway.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-gateway-gatewaynetwork.html#cfn-mediaconnect-gateway-gatewaynetwork-name
//
Name *string `field:"required" json:"name" yaml:"name"`
}
The network settings for a gateway.
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"
gatewayNetworkProperty := &GatewayNetworkProperty{
CidrBlock: jsii.String("cidrBlock"),
Name: jsii.String("name"),
}
Source Files
¶
- CfnBridge.go
- CfnBridgeOutput.go
- CfnBridgeOutputProps.go
- CfnBridgeOutput_BridgeNetworkOutputProperty.go
- CfnBridgeOutput__checks.go
- CfnBridgeProps.go
- CfnBridgeSource.go
- CfnBridgeSourceProps.go
- CfnBridgeSource_BridgeFlowSourceProperty.go
- CfnBridgeSource_BridgeNetworkSourceProperty.go
- CfnBridgeSource_VpcInterfaceAttachmentProperty.go
- CfnBridgeSource__checks.go
- CfnBridge_BridgeFlowSourceProperty.go
- CfnBridge_BridgeNetworkOutputProperty.go
- CfnBridge_BridgeNetworkSourceProperty.go
- CfnBridge_BridgeOutputProperty.go
- CfnBridge_BridgeSourceProperty.go
- CfnBridge_EgressGatewayBridgeProperty.go
- CfnBridge_FailoverConfigProperty.go
- CfnBridge_IngressGatewayBridgeProperty.go
- CfnBridge_SourcePriorityProperty.go
- CfnBridge_VpcInterfaceAttachmentProperty.go
- CfnBridge__checks.go
- CfnFlow.go
- CfnFlowEntitlement.go
- CfnFlowEntitlementProps.go
- CfnFlowEntitlement_EncryptionProperty.go
- CfnFlowEntitlement__checks.go
- CfnFlowOutput.go
- CfnFlowOutputProps.go
- CfnFlowOutput_EncryptionProperty.go
- CfnFlowOutput_VpcInterfaceAttachmentProperty.go
- CfnFlowOutput__checks.go
- CfnFlowProps.go
- CfnFlowSource.go
- CfnFlowSourceProps.go
- CfnFlowSource_EncryptionProperty.go
- CfnFlowSource_GatewayBridgeSourceProperty.go
- CfnFlowSource_VpcInterfaceAttachmentProperty.go
- CfnFlowSource__checks.go
- CfnFlowVpcInterface.go
- CfnFlowVpcInterfaceProps.go
- CfnFlowVpcInterface__checks.go
- CfnFlow_EncryptionProperty.go
- CfnFlow_FailoverConfigProperty.go
- CfnFlow_GatewayBridgeSourceProperty.go
- CfnFlow_SourcePriorityProperty.go
- CfnFlow_SourceProperty.go
- CfnFlow_VpcInterfaceAttachmentProperty.go
- CfnFlow__checks.go
- CfnGateway.go
- CfnGatewayProps.go
- CfnGateway_GatewayNetworkProperty.go
- CfnGateway__checks.go
- main.go
Directories
Click to show internal directories.
Click to hide internal directories.