Package software.amazon.awscdk.services.ecs

Interface CfnService.AdvancedConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnService.AdvancedConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnService

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

The advanced settings for a load balancer used in blue/green deployments.

Specify the alternate target group, listener rules, and IAM role required for traffic shifting during blue/green deployments. For more information, see Required resources for Amazon ECS blue/green deployments in the Amazon Elastic Container Service Developer Guide .

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.*;
 AdvancedConfigurationProperty advancedConfigurationProperty = AdvancedConfigurationProperty.builder()
         .alternateTargetGroupArn("alternateTargetGroupArn")
         // the properties below are optional
         .productionListenerRule("productionListenerRule")
         .roleArn("roleArn")
         .testListenerRule("testListenerRule")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnService.AdvancedConfigurationProperty.Builder	builder()
String	getAlternateTargetGroupArn()	The Amazon Resource Name (ARN) of the alternate target group for Amazon ECS blue/green deployments.
default String	getProductionListenerRule()	The Amazon Resource Name (ARN) that that identifies the production listener rule (in the case of an Application Load Balancer) or listener (in the case for an Network Load Balancer) for routing production traffic.
default String	getRoleArn()	The Amazon Resource Name (ARN) of the IAM role that grants Amazon ECS permission to call the Elastic Load Balancing APIs for you.
default String	getTestListenerRule()	The Amazon Resource Name (ARN) that identifies ) that identifies the test listener rule (in the case of an Application Load Balancer) or listener (in the case for an Network Load Balancer) for routing test traffic.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAlternateTargetGroupArn

@Stability(Stable)
@NotNull
String getAlternateTargetGroupArn()

The Amazon Resource Name (ARN) of the alternate target group for Amazon ECS blue/green deployments.

See Also:

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

getProductionListenerRule

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

The Amazon Resource Name (ARN) that that identifies the production listener rule (in the case of an Application Load Balancer) or listener (in the case for an Network Load Balancer) for routing production traffic.

See Also:

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

getRoleArn

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

The Amazon Resource Name (ARN) of the IAM role that grants Amazon ECS permission to call the Elastic Load Balancing APIs for you.

See Also:

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

getTestListenerRule

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

The Amazon Resource Name (ARN) that identifies ) that identifies the test listener rule (in the case of an Application Load Balancer) or listener (in the case for an Network Load Balancer) for routing test traffic.

See Also:

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

builder

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

Returns:

a CfnService.AdvancedConfigurationProperty.Builder of CfnService.AdvancedConfigurationProperty