software.amazon.awscdk.services.ecs

Interface CfnServiceProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnServiceProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-15T10:03:47.631Z")
 @Stability(value=Stable)
public interface CfnServiceProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `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.*;
 CfnServiceProps cfnServiceProps = CfnServiceProps.builder()
         .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	Interface and Description
static class	CfnServiceProps.Builder A builder for CfnServiceProps
static class	CfnServiceProps.Jsii$Proxy An implementation for CfnServiceProps

Method Summary

Modifier and Type	Method and Description
static CfnServiceProps.Builder	builder()
default Object	getCapacityProviderStrategy() `AWS::ECS::Service.CapacityProviderStrategy`.
default String	getCluster() `AWS::ECS::Service.Cluster`.
default Object	getDeploymentConfiguration() `AWS::ECS::Service.DeploymentConfiguration`.
default Object	getDeploymentController() `AWS::ECS::Service.DeploymentController`.
default Number	getDesiredCount() `AWS::ECS::Service.DesiredCount`.
default Object	getEnableEcsManagedTags() `AWS::ECS::Service.EnableECSManagedTags`.
default Object	getEnableExecuteCommand() `AWS::ECS::Service.EnableExecuteCommand`.
default Number	getHealthCheckGracePeriodSeconds() `AWS::ECS::Service.HealthCheckGracePeriodSeconds`.
default String	getLaunchType() `AWS::ECS::Service.LaunchType`.
default Object	getLoadBalancers() `AWS::ECS::Service.LoadBalancers`.
default Object	getNetworkConfiguration() `AWS::ECS::Service.NetworkConfiguration`.
default Object	getPlacementConstraints() `AWS::ECS::Service.PlacementConstraints`.
default Object	getPlacementStrategies() `AWS::ECS::Service.PlacementStrategies`.
default String	getPlatformVersion() `AWS::ECS::Service.PlatformVersion`.
default String	getPropagateTags() `AWS::ECS::Service.PropagateTags`.
default String	getRole() `AWS::ECS::Service.Role`.
default String	getSchedulingStrategy() `AWS::ECS::Service.SchedulingStrategy`.
default String	getServiceName() `AWS::ECS::Service.ServiceName`.
default Object	getServiceRegistries() `AWS::ECS::Service.ServiceRegistries`.
default List<CfnTag>	getTags() `AWS::ECS::Service.Tags`.
default String	getTaskDefinition() `AWS::ECS::Service.TaskDefinition`.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getCapacityProviderStrategy

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

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

getCluster

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

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

getDeploymentConfiguration

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

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

getDeploymentController

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

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

getDesiredCount

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

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

getEnableEcsManagedTags

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

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

getEnableExecuteCommand

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

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

getHealthCheckGracePeriodSeconds

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

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

getLaunchType

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

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

getLoadBalancers

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

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

getNetworkConfiguration

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

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

getPlacementConstraints

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

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

getPlacementStrategies

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

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

getPlatformVersion

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

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

getPropagateTags

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

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

getRole

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

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

getSchedulingStrategy

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

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

getServiceName

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

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

getServiceRegistries

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

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

getTags

@Stability(value=Stable)
 @Nullable
default List<CfnTag> getTags()

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

getTaskDefinition

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

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

builder

@Stability(value=Stable)
static CfnServiceProps.Builder builder()

Returns:

a CfnServiceProps.Builder of CfnServiceProps