Package software.amazon.awscdk.services.pipes

Interface CfnPipe.AwsVpcConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnPipe.AwsVpcConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnPipe

@Stability(Stable)
public static interface CfnPipe.AwsVpcConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

This structure specifies the VPC subnets and security groups for the task, and whether a public IP address is to be used.

This structure is relevant only for ECS tasks that use the awsvpc network mode.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.pipes.*;
 AwsVpcConfigurationProperty awsVpcConfigurationProperty = AwsVpcConfigurationProperty.builder()
         .subnets(List.of("subnets"))
         // the properties below are optional
         .assignPublicIp("assignPublicIp")
         .securityGroups(List.of("securityGroups"))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-awsvpcconfiguration.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnPipe.AwsVpcConfigurationProperty.Builder	A builder for CfnPipe.AwsVpcConfigurationProperty
static final class	CfnPipe.AwsVpcConfigurationProperty.Jsii$Proxy	An implementation for CfnPipe.AwsVpcConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnPipe.AwsVpcConfigurationProperty.Builder	builder()
default String	getAssignPublicIp()	Specifies whether the task's elastic network interface receives a public IP address.
default List<String>	getSecurityGroups()	Specifies the security groups associated with the task.
List<String>	getSubnets()	Specifies the subnets associated with the task.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getSubnets

@Stability(Stable)
@NotNull
List<String> getSubnets()

Specifies the subnets associated with the task.

These subnets must all be in the same VPC. You can specify as many as 16 subnets.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-awsvpcconfiguration.html#cfn-pipes-pipe-awsvpcconfiguration-subnets

getAssignPublicIp

@Stability(Stable)
@Nullable
default String getAssignPublicIp()

Specifies whether the task's elastic network interface receives a public IP address.

You can specify ENABLED only when LaunchType in EcsParameters is set to FARGATE .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-awsvpcconfiguration.html#cfn-pipes-pipe-awsvpcconfiguration-assignpublicip

getSecurityGroups

@Stability(Stable)
@Nullable
default List<String> getSecurityGroups()

Specifies the security groups associated with the task.

These security groups must all be in the same VPC. You can specify as many as five security groups. If you do not specify a security group, the default security group for the VPC is used.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-awsvpcconfiguration.html#cfn-pipes-pipe-awsvpcconfiguration-securitygroups

builder

@Stability(Stable)
static CfnPipe.AwsVpcConfigurationProperty.Builder builder()

Returns:

a CfnPipe.AwsVpcConfigurationProperty.Builder of CfnPipe.AwsVpcConfigurationProperty