Experimental
@aws-cdk/aws-mediaconnect-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.
Gateway L2 construct
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
declare const stack: Stack;
const productionNetwork = GatewayNetwork.define({
cidrBlock: '192.168.1.0/24',
name: 'production-network',
});
const gateway = new Gateway(stack, 'MyGateway', {
gatewayName: 'my-gateway',
egressCidrBlocks: ['10.0.0.0/16'],
networks: [productionNetwork],
});
# stack: Stack
production_network = GatewayNetwork.define(
cidr_block="192.168.1.0/24",
name="production-network"
)
gateway = Gateway(stack, "MyGateway",
gateway_name="my-gateway",
egress_cidr_blocks=["10.0.0.0/16"],
networks=[production_network]
)
Stack stack;
GatewayNetwork productionNetwork = GatewayNetwork.define(GatewayNetworkDefineProps.builder()
.cidrBlock("192.168.1.0/24")
.name("production-network")
.build());
Gateway gateway = Gateway.Builder.create(stack, "MyGateway")
.gatewayName("my-gateway")
.egressCidrBlocks(List.of("10.0.0.0/16"))
.networks(List.of(productionNetwork))
.build();
// Install: dotnet add package Amazon.CDK.AWS.MediaConnect.Alpha
Stack stack;
var productionNetwork = GatewayNetwork.Define(new GatewayNetworkDefineProps {
CidrBlock = "192.168.1.0/24",
Name = "production-network"
});
var gateway = new Gateway(stack, "MyGateway", new GatewayProps {
GatewayName = "my-gateway",
EgressCidrBlocks = new [] { "10.0.0.0/16" },
Networks = new [] { productionNetwork }
});
// Install: go get github.com/aws/aws-cdk-go/awsmediaconnectalpha/v2
var stack Stack
productionNetwork := awsmediaconnectalpha.GatewayNetwork_Define(&GatewayNetworkDefineProps{
CidrBlock: jsii.String("192.168.1.0/24"),
Name: jsii.String("production-network"),
})
gateway := awsmediaconnectalpha.NewGateway(stack, jsii.String("MyGateway"), &GatewayProps{
GatewayName: jsii.String("my-gateway"),
EgressCidrBlocks: []*string{
jsii.String("10.0.0.0/16"),
},
Networks: []GatewayNetwork{
productionNetwork,
},
})
Initializer
new Gateway(scope: Construct, id: string, props: GatewayProps)
Gateway(scope: Construct, id: str, props: GatewayProps)
new Gateway(Construct scope, String id, GatewayProps props)
new Gateway(Construct scope, string id, GatewayProps props)
NewGateway(Scope Construct, Id *string, Props GatewayProps)
Construct Props
egressCidrBlocksstring[]egress_cidr_blockstyping.List[str]egressCidrBlocksList<String>EgressCidrBlocksstring[]EgressCidrBlocks*[]*stringrequired#These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
gatewayNamestringgateway_namestrgatewayNameStringGatewayNamestringGatewayName*string= autogenerated#This name can not be modified after the gateway is created.
networksGatewayNetwork[]networkstyping.List[GatewayNetwork]networksList<GatewayNetwork>NetworksGatewayNetwork[]Networks*[]GatewayNetworkrequired#A gateway must have between 1 and 4 networks. Provide the initial set here; use addNetwork() to add more (up to 4 total).
Properties
envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironmentrequired#notes
For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.
For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.
gatewayRefGatewayReferencegateway_refGatewayReferencegatewayRefGatewayReferenceGatewayRefGatewayReferenceGatewayRefGatewayReferencerequired#PROPERTY_INJECTION_IDstringproperty_injection_idstrPROPERTY_INJECTION_IDStringPROPERTY_INJECTION_IDstringPROPERTY_INJECTION_ID*stringrequiredstatic#Methods
addNetwork(network: GatewayNetwork): GatewayNetworkdef add_network(self, network: GatewayNetwork) -> GatewayNetworkpublic GatewayNetwork addNetwork(GatewayNetwork network)public GatewayNetwork AddNetwork(GatewayNetwork network)func AddNetwork(Network GatewayNetwork) GatewayNetwork#applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#notes · 1 parameter
When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.
Parameters
strengthstrengthstrengthstrengthStrength— - The reference strength to use for this resource.
applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#notes
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).
fromGatewayArn(scope: Construct, id: string, gatewayArn: string): IGateway@staticmethod def from_gateway_arn(scope: Construct, id: str, gateway_arn: str) -> IGatewaypublic static IGateway fromGatewayArn(Construct scope, String id, String gatewayArn)public static IGateway FromGatewayArn(Construct scope, string id, string gatewayArn)func FromGatewayArn(Scope Construct, Id *string, GatewayArn *string) IGatewaystatic#isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#notes · 1 parameter · returns
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.
Parameters
xxxxX— Any object.
Returns: true if x is an object created from a class which extends Construct.
isOwnedResource(construct: IConstruct): boolean@staticmethod def is_owned_resource(construct: IConstruct) -> boolpublic static Boolean isOwnedResource(IConstruct construct)public static bool IsOwnedResource(IConstruct construct)func IsOwnedResource(Construct IConstruct) *boolstatic#isResource(construct: IConstruct): boolean@staticmethod def is_resource(construct: IConstruct) -> boolpublic static Boolean isResource(IConstruct construct)public static bool IsResource(IConstruct construct)func IsResource(Construct IConstruct) *boolstatic#metric(metricName: string, props?: MetricOptions): Metricdef metric(self, metric_name: str, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metric(String metricName, MetricOptions props)public Metric Metric(string metricName, MetricOptions? props = null)func Metric(MetricName *string, Props MetricOptions) Metric#metricEgressBridgeDroppedPackets(props?: MetricOptions): Metricdef metric_egress_bridge_dropped_packets(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricEgressBridgeDroppedPackets(MetricOptions props)public Metric MetricEgressBridgeDroppedPackets(MetricOptions? props = null)func MetricEgressBridgeDroppedPackets(Props MetricOptions) Metric#metricEgressBridgeTotalPackets(props?: MetricOptions): Metricdef metric_egress_bridge_total_packets(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricEgressBridgeTotalPackets(MetricOptions props)public Metric MetricEgressBridgeTotalPackets(MetricOptions? props = null)func MetricEgressBridgeTotalPackets(Props MetricOptions) Metric#metricIngressBridgeDroppedPackets(props?: MetricOptions): Metricdef metric_ingress_bridge_dropped_packets(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricIngressBridgeDroppedPackets(MetricOptions props)public Metric MetricIngressBridgeDroppedPackets(MetricOptions? props = null)func MetricIngressBridgeDroppedPackets(Props MetricOptions) Metric#metricIngressBridgeTotalPackets(props?: MetricOptions): Metricdef metric_ingress_bridge_total_packets(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricIngressBridgeTotalPackets(MetricOptions props)public Metric MetricIngressBridgeTotalPackets(MetricOptions? props = null)func MetricIngressBridgeTotalPackets(Props MetricOptions) Metric#toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.