Show / Hide Table of Contents

Class CfnPipePropsMixin.AwsVpcConfigurationProperty

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

Inheritance
object
CfnPipePropsMixin.AwsVpcConfigurationProperty
Implements
CfnPipePropsMixin.IAwsVpcConfigurationProperty
Inherited Members
object.GetType()
object.MemberwiseClone()
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
Namespace: Amazon.CDK.Mixins.Preview.AWS.Pipes.Mixins
Assembly: Amazon.CDK.Mixins.Preview.dll
Syntax (csharp)
public class CfnPipePropsMixin.AwsVpcConfigurationProperty : CfnPipePropsMixin.IAwsVpcConfigurationProperty
Syntax (vb)
Public Class CfnPipePropsMixin.AwsVpcConfigurationProperty Implements CfnPipePropsMixin.IAwsVpcConfigurationProperty
Remarks

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

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

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.Mixins.Preview.AWS.Pipes.Mixins;

             var awsVpcConfigurationProperty = new AwsVpcConfigurationProperty {
                 AssignPublicIp = "assignPublicIp",
                 SecurityGroups = new [] { "securityGroups" },
                 Subnets = new [] { "subnets" }
             };

Synopsis

Constructors

AwsVpcConfigurationProperty()

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

Properties

AssignPublicIp

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

SecurityGroups

Specifies the security groups associated with the task.

Subnets

Specifies the subnets associated with the task.

Constructors

AwsVpcConfigurationProperty()

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

public AwsVpcConfigurationProperty()
Remarks

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

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

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.Mixins.Preview.AWS.Pipes.Mixins;

             var awsVpcConfigurationProperty = new AwsVpcConfigurationProperty {
                 AssignPublicIp = "assignPublicIp",
                 SecurityGroups = new [] { "securityGroups" },
                 Subnets = new [] { "subnets" }
             };

Properties

AssignPublicIp

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

public string? AssignPublicIp { get; set; }
Property Value

string

Remarks

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

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

SecurityGroups

Specifies the security groups associated with the task.

public string[]? SecurityGroups { get; set; }
Property Value

string[]

Remarks

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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-awsvpcconfiguration.html#cfn-pipes-pipe-awsvpcconfiguration-securitygroups

Subnets

Specifies the subnets associated with the task.

public string[]? Subnets { get; set; }
Property Value

string[]

Remarks

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

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

Implements

CfnPipePropsMixin.IAwsVpcConfigurationProperty
Back to top Generated by DocFX