Package software.amazon.awscdk.services.ecs

Interface CfnService.VpcLatticeConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnService.VpcLatticeConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnService

@Stability(Stable)
public static interface CfnService.VpcLatticeConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

The VPC Lattice configuration for your service that holds the information for the target group(s) Amazon ECS tasks will be registered to.

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.ecs.*;
 VpcLatticeConfigurationProperty vpcLatticeConfigurationProperty = VpcLatticeConfigurationProperty.builder()
         .portName("portName")
         .roleArn("roleArn")
         .targetGroupArn("targetGroupArn")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-vpclatticeconfiguration.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnService.VpcLatticeConfigurationProperty.Builder	builder()
String	getPortName()	The name of the port mapping to register in the VPC Lattice target group.
String	getRoleArn()	The ARN of the IAM role to associate with this VPC Lattice configuration.
String	getTargetGroupArn()	The full Amazon Resource Name (ARN) of the target group or groups associated with the VPC Lattice configuration that the Amazon ECS tasks will be registered to.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getPortName

@Stability(Stable)
@NotNull
String getPortName()

The name of the port mapping to register in the VPC Lattice target group.

This is the name of the portMapping you defined in your task definition.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-vpclatticeconfiguration.html#cfn-ecs-service-vpclatticeconfiguration-portname

getRoleArn

@Stability(Stable)
@NotNull
String getRoleArn()

The ARN of the IAM role to associate with this VPC Lattice configuration.

This is the Amazon ECS infrastructure IAM role that is used to manage your VPC Lattice infrastructure.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-vpclatticeconfiguration.html#cfn-ecs-service-vpclatticeconfiguration-rolearn

getTargetGroupArn

@Stability(Stable)
@NotNull
String getTargetGroupArn()

The full Amazon Resource Name (ARN) of the target group or groups associated with the VPC Lattice configuration that the Amazon ECS tasks will be registered to.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-vpclatticeconfiguration.html#cfn-ecs-service-vpclatticeconfiguration-targetgrouparn

builder

@Stability(Stable)
static CfnService.VpcLatticeConfigurationProperty.Builder builder()

Returns:

a CfnService.VpcLatticeConfigurationProperty.Builder of CfnService.VpcLatticeConfigurationProperty