Skip to content
v2.276.0

Experimental

@aws-cdk/aws-medialive-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

VpcOutputSettings Struct ​

VPC output settings for the channel.

When configured, all output endpoints are created within the specified VPC.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as medialive_alpha from '@aws-cdk/aws-medialive-alpha';
import { aws_ec2 as interfaces_ec2 } from 'aws-cdk-lib/interfaces';
import { aws_elasticache as interfaces_elasticache } from 'aws-cdk-lib/interfaces';

declare const securityGroupRef: interfaces_elasticache.ISecurityGroupRef;
declare const subnetRef: interfaces_ec2.ISubnetRef;
const vpcOutputSettings: medialive_alpha.VpcOutputSettings = {
  subnets: [subnetRef],

  // the properties below are optional
  publicAddressAllocationIds: ['publicAddressAllocationIds'],
  securityGroups: [securityGroupRef],
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_medialive_alpha as medialive_alpha
from aws_cdk.interfaces import aws_ec2 as interfaces_ec2
from aws_cdk.interfaces import aws_elasticache as interfaces_elasticache

# security_group_ref: interfaces_elasticache.ISecurityGroupRef
# subnet_ref: interfaces_ec2.ISubnetRef

vpc_output_settings = medialive_alpha.VpcOutputSettings(
    subnets=[subnet_ref],

    # the properties below are optional
    public_address_allocation_ids=["publicAddressAllocationIds"],
    security_groups=[security_group_ref]
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.medialive.alpha.*;
import software.amazon.awscdk.interfaces.ec2.*;
import software.amazon.awscdk.interfaces.elasticache.*;

ISecurityGroupRef securityGroupRef;
ISubnetRef subnetRef;

VpcOutputSettings vpcOutputSettings = VpcOutputSettings.builder()
        .subnets(List.of(subnetRef))

        // the properties below are optional
        .publicAddressAllocationIds(List.of("publicAddressAllocationIds"))
        .securityGroups(List.of(securityGroupRef))
        .build();
csharp
// Install: dotnet add package Amazon.CDK.AWS.MediaLive.Alpha
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.MediaLive.Alpha;
using Amazon.CDK.Interfaces.EC2;
using Amazon.CDK.Interfaces.ElastiCache;

ISecurityGroupRef securityGroupRef;
ISubnetRef subnetRef;

var vpcOutputSettings = new VpcOutputSettings {
    Subnets = new [] { subnetRef },

    // the properties below are optional
    PublicAddressAllocationIds = new [] { "publicAddressAllocationIds" },
    SecurityGroups = new [] { securityGroupRef }
};
go
// Install: go get github.com/aws/aws-cdk-go/awsmedialivealpha/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import medialive_alpha "github.com/aws/aws-cdk-go/awsmedialivealpha"
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"

var securityGroupRef ISecurityGroupRef
var subnetRef ISubnetRef

vpcOutputSettings := &VpcOutputSettings{
	Subnets: []ISubnetRef{
		subnetRef,
	},

	// the properties below are optional
	PublicAddressAllocationIds: []*string{
		jsii.String("publicAddressAllocationIds"),
	},
	SecurityGroups: []ISecurityGroupRef{
		securityGroupRef,
	},
}

Properties ​

publicAddressAllocationIdsoptionalstring[]public_address_allocation_idsoptionaltyping.List[str]publicAddressAllocationIdsoptionalList<String>PublicAddressAllocationIdsoptionalstring[]PublicAddressAllocationIdsoptional*[]*string#
Public address allocation IDs to associate with ENIs created in the output VPC.

Default: no public addresses

Must specify one for SINGLE_PIPELINE, two for STANDARD channels.

securityGroupsoptionalISecurityGroupRef[]security_groupsoptionaltyping.List[ISecurityGroupRef]securityGroupsoptionalList<ISecurityGroupRef>SecurityGroupsoptionalISecurityGroupRef[]SecurityGroupsoptional*[]ISecurityGroupRef#
The security groups to attach to the output VPC network interfaces.

Default: VPC default security group

subnetsISubnetRef[]subnetstyping.List[ISubnetRef]subnetsList<ISubnetRef>SubnetsISubnetRef[]Subnets*[]ISubnetRefrequired#
The subnets to use for the channel's output endpoints.

For STANDARD channels, provide subnets in two different availability zones. For SINGLE_PIPELINE channels, provide at least one subnet.