software.amazon.awscdk.services.ecs

Class CfnService

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.ecs.CfnService

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-22T10:27:17.204Z")
 @Stability(value=Stable)
public class CfnService
extends CfnResource
implements IInspectable

A CloudFormation `AWS::ECS::Service`.

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.*;
 CfnService cfnService = CfnService.Builder.create(this, "MyCfnService")
         .capacityProviderStrategy(List.of(CapacityProviderStrategyItemProperty.builder()
                 .base(123)
                 .capacityProvider("capacityProvider")
                 .weight(123)
                 .build()))
         .cluster("cluster")
         .deploymentConfiguration(DeploymentConfigurationProperty.builder()
                 .deploymentCircuitBreaker(DeploymentCircuitBreakerProperty.builder()
                         .enable(false)
                         .rollback(false)
                         .build())
                 .maximumPercent(123)
                 .minimumHealthyPercent(123)
                 .build())
         .deploymentController(DeploymentControllerProperty.builder()
                 .type("type")
                 .build())
         .desiredCount(123)
         .enableEcsManagedTags(false)
         .enableExecuteCommand(false)
         .healthCheckGracePeriodSeconds(123)
         .launchType("launchType")
         .loadBalancers(List.of(LoadBalancerProperty.builder()
                 .containerPort(123)
                 // the properties below are optional
                 .containerName("containerName")
                 .loadBalancerName("loadBalancerName")
                 .targetGroupArn("targetGroupArn")
                 .build()))
         .networkConfiguration(NetworkConfigurationProperty.builder()
                 .awsvpcConfiguration(AwsVpcConfigurationProperty.builder()
                         .subnets(List.of("subnets"))
                         // the properties below are optional
                         .assignPublicIp("assignPublicIp")
                         .securityGroups(List.of("securityGroups"))
                         .build())
                 .build())
         .placementConstraints(List.of(PlacementConstraintProperty.builder()
                 .type("type")
                 // the properties below are optional
                 .expression("expression")
                 .build()))
         .placementStrategies(List.of(PlacementStrategyProperty.builder()
                 .type("type")
                 // the properties below are optional
                 .field("field")
                 .build()))
         .platformVersion("platformVersion")
         .propagateTags("propagateTags")
         .role("role")
         .schedulingStrategy("schedulingStrategy")
         .serviceName("serviceName")
         .serviceRegistries(List.of(ServiceRegistryProperty.builder()
                 .containerName("containerName")
                 .containerPort(123)
                 .port(123)
                 .registryArn("registryArn")
                 .build()))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .taskDefinition("taskDefinition")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnService.AwsVpcConfigurationProperty Example:
static class	CfnService.Builder A fluent builder for CfnService.
static interface	CfnService.CapacityProviderStrategyItemProperty Example:
static interface	CfnService.DeploymentCircuitBreakerProperty Example:
static interface	CfnService.DeploymentConfigurationProperty Example:
static interface	CfnService.DeploymentControllerProperty Example:
static interface	CfnService.LoadBalancerProperty Example:
static interface	CfnService.NetworkConfigurationProperty Example:
static interface	CfnService.PlacementConstraintProperty Example:
static interface	CfnService.PlacementStrategyProperty Example:
static interface	CfnService.ServiceRegistryProperty Example:

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnService(software.constructs.Construct scope, String id) Create a new `AWS::ECS::Service`.
	CfnService(software.constructs.Construct scope, String id, CfnServiceProps props) Create a new `AWS::ECS::Service`.
protected	CfnService(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnService(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrName()
String	getAttrServiceArn()
Object	getCapacityProviderStrategy() `AWS::ECS::Service.CapacityProviderStrategy`.
protected Map<String,Object>	getCfnProperties()
String	getCluster() `AWS::ECS::Service.Cluster`.
Object	getDeploymentConfiguration() `AWS::ECS::Service.DeploymentConfiguration`.
Object	getDeploymentController() `AWS::ECS::Service.DeploymentController`.
Number	getDesiredCount() `AWS::ECS::Service.DesiredCount`.
Object	getEnableEcsManagedTags() `AWS::ECS::Service.EnableECSManagedTags`.
Object	getEnableExecuteCommand() `AWS::ECS::Service.EnableExecuteCommand`.
Number	getHealthCheckGracePeriodSeconds() `AWS::ECS::Service.HealthCheckGracePeriodSeconds`.
String	getLaunchType() `AWS::ECS::Service.LaunchType`.
Object	getLoadBalancers() `AWS::ECS::Service.LoadBalancers`.
Object	getNetworkConfiguration() `AWS::ECS::Service.NetworkConfiguration`.
Object	getPlacementConstraints() `AWS::ECS::Service.PlacementConstraints`.
Object	getPlacementStrategies() `AWS::ECS::Service.PlacementStrategies`.
String	getPlatformVersion() `AWS::ECS::Service.PlatformVersion`.
String	getPropagateTags() `AWS::ECS::Service.PropagateTags`.
String	getRole() `AWS::ECS::Service.Role`.
String	getSchedulingStrategy() `AWS::ECS::Service.SchedulingStrategy`.
String	getServiceName() `AWS::ECS::Service.ServiceName`.
Object	getServiceRegistries() `AWS::ECS::Service.ServiceRegistries`.
TagManager	getTags() `AWS::ECS::Service.Tags`.
String	getTaskDefinition() `AWS::ECS::Service.TaskDefinition`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setCapacityProviderStrategy(IResolvable value) `AWS::ECS::Service.CapacityProviderStrategy`.
void	setCapacityProviderStrategy(List<Object> value) `AWS::ECS::Service.CapacityProviderStrategy`.
void	setCluster(String value) `AWS::ECS::Service.Cluster`.
void	setDeploymentConfiguration(CfnService.DeploymentConfigurationProperty value) `AWS::ECS::Service.DeploymentConfiguration`.
void	setDeploymentConfiguration(IResolvable value) `AWS::ECS::Service.DeploymentConfiguration`.
void	setDeploymentController(CfnService.DeploymentControllerProperty value) `AWS::ECS::Service.DeploymentController`.
void	setDeploymentController(IResolvable value) `AWS::ECS::Service.DeploymentController`.
void	setDesiredCount(Number value) `AWS::ECS::Service.DesiredCount`.
void	setEnableEcsManagedTags(Boolean value) `AWS::ECS::Service.EnableECSManagedTags`.
void	setEnableEcsManagedTags(IResolvable value) `AWS::ECS::Service.EnableECSManagedTags`.
void	setEnableExecuteCommand(Boolean value) `AWS::ECS::Service.EnableExecuteCommand`.
void	setEnableExecuteCommand(IResolvable value) `AWS::ECS::Service.EnableExecuteCommand`.
void	setHealthCheckGracePeriodSeconds(Number value) `AWS::ECS::Service.HealthCheckGracePeriodSeconds`.
void	setLaunchType(String value) `AWS::ECS::Service.LaunchType`.
void	setLoadBalancers(IResolvable value) `AWS::ECS::Service.LoadBalancers`.
void	setLoadBalancers(List<Object> value) `AWS::ECS::Service.LoadBalancers`.
void	setNetworkConfiguration(CfnService.NetworkConfigurationProperty value) `AWS::ECS::Service.NetworkConfiguration`.
void	setNetworkConfiguration(IResolvable value) `AWS::ECS::Service.NetworkConfiguration`.
void	setPlacementConstraints(IResolvable value) `AWS::ECS::Service.PlacementConstraints`.
void	setPlacementConstraints(List<Object> value) `AWS::ECS::Service.PlacementConstraints`.
void	setPlacementStrategies(IResolvable value) `AWS::ECS::Service.PlacementStrategies`.
void	setPlacementStrategies(List<Object> value) `AWS::ECS::Service.PlacementStrategies`.
void	setPlatformVersion(String value) `AWS::ECS::Service.PlatformVersion`.
void	setPropagateTags(String value) `AWS::ECS::Service.PropagateTags`.
void	setRole(String value) `AWS::ECS::Service.Role`.
void	setSchedulingStrategy(String value) `AWS::ECS::Service.SchedulingStrategy`.
void	setServiceName(String value) `AWS::ECS::Service.ServiceName`.
void	setServiceRegistries(IResolvable value) `AWS::ECS::Service.ServiceRegistries`.
void	setServiceRegistries(List<Object> value) `AWS::ECS::Service.ServiceRegistries`.
void	setTaskDefinition(String value) `AWS::ECS::Service.TaskDefinition`.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnService

protected CfnService(software.amazon.jsii.JsiiObjectRef objRef)

CfnService

protected CfnService(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnService

@Stability(value=Stable)
public CfnService(@NotNull
                                           software.constructs.Construct scope,
                                           @NotNull
                                           String id,
                                           @Nullable
                                           CfnServiceProps props)

Create a new `AWS::ECS::Service`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties.

CfnService

@Stability(value=Stable)
public CfnService(@NotNull
                                           software.constructs.Construct scope,
                                           @NotNull
                                           String id)

Create a new `AWS::ECS::Service`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrName

@Stability(value=Stable)
 @NotNull
public String getAttrName()

getAttrServiceArn

@Stability(value=Stable)
 @NotNull
public String getAttrServiceArn()

getCapacityProviderStrategy

@Stability(value=Stable)
 @Nullable
public Object getCapacityProviderStrategy()

`AWS::ECS::Service.CapacityProviderStrategy`.

setCapacityProviderStrategy

@Stability(value=Stable)
public void setCapacityProviderStrategy(@Nullable
                                                                 IResolvable value)

`AWS::ECS::Service.CapacityProviderStrategy`.

setCapacityProviderStrategy

@Stability(value=Stable)
public void setCapacityProviderStrategy(@Nullable
                                                                 List<Object> value)

`AWS::ECS::Service.CapacityProviderStrategy`.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getCluster

@Stability(value=Stable)
 @Nullable
public String getCluster()

`AWS::ECS::Service.Cluster`.

setCluster

@Stability(value=Stable)
public void setCluster(@Nullable
                                                String value)

`AWS::ECS::Service.Cluster`.

getDeploymentConfiguration

@Stability(value=Stable)
 @Nullable
public Object getDeploymentConfiguration()

`AWS::ECS::Service.DeploymentConfiguration`.

setDeploymentConfiguration

@Stability(value=Stable)
public void setDeploymentConfiguration(@Nullable
                                                                CfnService.DeploymentConfigurationProperty value)

`AWS::ECS::Service.DeploymentConfiguration`.

setDeploymentConfiguration

@Stability(value=Stable)
public void setDeploymentConfiguration(@Nullable
                                                                IResolvable value)

`AWS::ECS::Service.DeploymentConfiguration`.

getDeploymentController

@Stability(value=Stable)
 @Nullable
public Object getDeploymentController()

`AWS::ECS::Service.DeploymentController`.

setDeploymentController

@Stability(value=Stable)
public void setDeploymentController(@Nullable
                                                             CfnService.DeploymentControllerProperty value)

`AWS::ECS::Service.DeploymentController`.

setDeploymentController

@Stability(value=Stable)
public void setDeploymentController(@Nullable
                                                             IResolvable value)

`AWS::ECS::Service.DeploymentController`.

getDesiredCount

@Stability(value=Stable)
 @Nullable
public Number getDesiredCount()

`AWS::ECS::Service.DesiredCount`.

setDesiredCount

@Stability(value=Stable)
public void setDesiredCount(@Nullable
                                                     Number value)

`AWS::ECS::Service.DesiredCount`.

getEnableEcsManagedTags

@Stability(value=Stable)
 @Nullable
public Object getEnableEcsManagedTags()

`AWS::ECS::Service.EnableECSManagedTags`.

setEnableEcsManagedTags

@Stability(value=Stable)
public void setEnableEcsManagedTags(@Nullable
                                                             Boolean value)

`AWS::ECS::Service.EnableECSManagedTags`.

setEnableEcsManagedTags

@Stability(value=Stable)
public void setEnableEcsManagedTags(@Nullable
                                                             IResolvable value)

`AWS::ECS::Service.EnableECSManagedTags`.

getEnableExecuteCommand

@Stability(value=Stable)
 @Nullable
public Object getEnableExecuteCommand()

`AWS::ECS::Service.EnableExecuteCommand`.

setEnableExecuteCommand

@Stability(value=Stable)
public void setEnableExecuteCommand(@Nullable
                                                             Boolean value)

`AWS::ECS::Service.EnableExecuteCommand`.

setEnableExecuteCommand

@Stability(value=Stable)
public void setEnableExecuteCommand(@Nullable
                                                             IResolvable value)

`AWS::ECS::Service.EnableExecuteCommand`.

getHealthCheckGracePeriodSeconds

@Stability(value=Stable)
 @Nullable
public Number getHealthCheckGracePeriodSeconds()

`AWS::ECS::Service.HealthCheckGracePeriodSeconds`.

setHealthCheckGracePeriodSeconds

@Stability(value=Stable)
public void setHealthCheckGracePeriodSeconds(@Nullable
                                                                      Number value)

`AWS::ECS::Service.HealthCheckGracePeriodSeconds`.

getLaunchType

@Stability(value=Stable)
 @Nullable
public String getLaunchType()

`AWS::ECS::Service.LaunchType`.

setLaunchType

@Stability(value=Stable)
public void setLaunchType(@Nullable
                                                   String value)

`AWS::ECS::Service.LaunchType`.

getLoadBalancers

@Stability(value=Stable)
 @Nullable
public Object getLoadBalancers()

`AWS::ECS::Service.LoadBalancers`.

setLoadBalancers

@Stability(value=Stable)
public void setLoadBalancers(@Nullable
                                                      IResolvable value)

`AWS::ECS::Service.LoadBalancers`.

setLoadBalancers

@Stability(value=Stable)
public void setLoadBalancers(@Nullable
                                                      List<Object> value)

`AWS::ECS::Service.LoadBalancers`.

getNetworkConfiguration

@Stability(value=Stable)
 @Nullable
public Object getNetworkConfiguration()

`AWS::ECS::Service.NetworkConfiguration`.

setNetworkConfiguration

@Stability(value=Stable)
public void setNetworkConfiguration(@Nullable
                                                             CfnService.NetworkConfigurationProperty value)

`AWS::ECS::Service.NetworkConfiguration`.

setNetworkConfiguration

@Stability(value=Stable)
public void setNetworkConfiguration(@Nullable
                                                             IResolvable value)

`AWS::ECS::Service.NetworkConfiguration`.

getPlacementConstraints

@Stability(value=Stable)
 @Nullable
public Object getPlacementConstraints()

`AWS::ECS::Service.PlacementConstraints`.

setPlacementConstraints

@Stability(value=Stable)
public void setPlacementConstraints(@Nullable
                                                             IResolvable value)

`AWS::ECS::Service.PlacementConstraints`.

setPlacementConstraints

@Stability(value=Stable)
public void setPlacementConstraints(@Nullable
                                                             List<Object> value)

`AWS::ECS::Service.PlacementConstraints`.

getPlacementStrategies

@Stability(value=Stable)
 @Nullable
public Object getPlacementStrategies()

`AWS::ECS::Service.PlacementStrategies`.

setPlacementStrategies

@Stability(value=Stable)
public void setPlacementStrategies(@Nullable
                                                            IResolvable value)

`AWS::ECS::Service.PlacementStrategies`.

setPlacementStrategies

@Stability(value=Stable)
public void setPlacementStrategies(@Nullable
                                                            List<Object> value)

`AWS::ECS::Service.PlacementStrategies`.

getPlatformVersion

@Stability(value=Stable)
 @Nullable
public String getPlatformVersion()

`AWS::ECS::Service.PlatformVersion`.

setPlatformVersion

@Stability(value=Stable)
public void setPlatformVersion(@Nullable
                                                        String value)

`AWS::ECS::Service.PlatformVersion`.

getPropagateTags

@Stability(value=Stable)
 @Nullable
public String getPropagateTags()

`AWS::ECS::Service.PropagateTags`.

setPropagateTags

@Stability(value=Stable)
public void setPropagateTags(@Nullable
                                                      String value)

`AWS::ECS::Service.PropagateTags`.

getRole

@Stability(value=Stable)
 @Nullable
public String getRole()

`AWS::ECS::Service.Role`.

setRole

@Stability(value=Stable)
public void setRole(@Nullable
                                             String value)

`AWS::ECS::Service.Role`.

getSchedulingStrategy

@Stability(value=Stable)
 @Nullable
public String getSchedulingStrategy()

`AWS::ECS::Service.SchedulingStrategy`.

setSchedulingStrategy

@Stability(value=Stable)
public void setSchedulingStrategy(@Nullable
                                                           String value)

`AWS::ECS::Service.SchedulingStrategy`.

getServiceName

@Stability(value=Stable)
 @Nullable
public String getServiceName()

`AWS::ECS::Service.ServiceName`.

setServiceName

@Stability(value=Stable)
public void setServiceName(@Nullable
                                                    String value)

`AWS::ECS::Service.ServiceName`.

getServiceRegistries

@Stability(value=Stable)
 @Nullable
public Object getServiceRegistries()

`AWS::ECS::Service.ServiceRegistries`.

setServiceRegistries

@Stability(value=Stable)
public void setServiceRegistries(@Nullable
                                                          IResolvable value)

`AWS::ECS::Service.ServiceRegistries`.

setServiceRegistries

@Stability(value=Stable)
public void setServiceRegistries(@Nullable
                                                          List<Object> value)

`AWS::ECS::Service.ServiceRegistries`.

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

`AWS::ECS::Service.Tags`.

getTaskDefinition

@Stability(value=Stable)
 @Nullable
public String getTaskDefinition()

`AWS::ECS::Service.TaskDefinition`.

setTaskDefinition

@Stability(value=Stable)
public void setTaskDefinition(@Nullable
                                                       String value)

`AWS::ECS::Service.TaskDefinition`.