software.amazon.awscdk.services.ecs

Interface FargateServiceProps

All Superinterfaces:

BaseServiceOptions, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

FargateServiceProps.Jsii$Proxy

@Generated(value="jsii-pacmak/0.20.4 (build 96d89e1)",
           date="2019-11-12T11:54:58.379Z")
 @Stability(value=Stable)
public interface FargateServiceProps
extends software.amazon.jsii.JsiiSerializable, BaseServiceOptions

The properties for defining a service using the Fargate launch type.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static FargateServiceProps.Builder	builder()
default Boolean	getAssignPublicIp() Specifies whether the task's elastic network interface receives a public IP address.
default FargatePlatformVersion	getPlatformVersion() The platform version on which to run your service.
default PropagatedTagSource	getPropagateTaskTagsFrom() Deprecated. Use `propagateTags` instead.
default ISecurityGroup	getSecurityGroup() The security groups to associate with the service.
TaskDefinition	getTaskDefinition() The task definition to use for tasks in the service.
default SubnetSelection	getVpcSubnets() The subnets to associate with the service.

Methods inherited from interface software.amazon.awscdk.services.ecs.BaseServiceOptions

getCloudMapOptions, getCluster, getDesiredCount, getEnableEcsManagedTags, getHealthCheckGracePeriod, getMaxHealthyPercent, getMinHealthyPercent, getPropagateTags, getServiceName

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getTaskDefinition

@Stability(value=Stable)
TaskDefinition getTaskDefinition()

The task definition to use for tasks in the service. [disable-awslint:ref-via-interface]

getAssignPublicIp

@Stability(value=Stable)
default Boolean getAssignPublicIp()

Specifies whether the task's elastic network interface receives a public IP address. If true, each task will receive a public IP address. Default: - Use subnet default.

getPlatformVersion

@Stability(value=Stable)
default FargatePlatformVersion getPlatformVersion()

The platform version on which to run your service. If one is not specified, the LATEST platform version is used by default. For more information, see [AWS Fargate Platform Versions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) in the Amazon Elastic Container Service Developer Guide. Default: Latest

getPropagateTaskTagsFrom

@Stability(value=Deprecated)
 @Deprecated
default PropagatedTagSource getPropagateTaskTagsFrom()

Deprecated. Use `propagateTags` instead.

Specifies whether to propagate the tags from the task definition or the service to the tasks in the service. Tags can only be propagated to the tasks within the service during service creation. Default: PropagatedTagSource.NONE

getSecurityGroup

@Stability(value=Stable)
default ISecurityGroup getSecurityGroup()

The security groups to associate with the service. If you do not specify a security group, the default security group for the VPC is used. Default: - A new security group is created.

getVpcSubnets

@Stability(value=Stable)
default SubnetSelection getVpcSubnets()

The subnets to associate with the service. Default: - Private subnets.

builder

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

Specified by:

builder in interface BaseServiceOptions

Returns:

a FargateServiceProps.Builder of FargateServiceProps