Package software.amazon.awscdk.services.ecs

Class CfnPrimaryTaskSet

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.CfnPrimaryTaskSet

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-22T02:24:00.937Z")
@Stability(Stable)
public class CfnPrimaryTaskSet
extends CfnResource
implements IInspectable

Modifies which task set in a service is the primary task set.

Any parameters that are updated on the primary task set in a service will transition to the service. This is used when a service uses the EXTERNAL deployment controller type. For more information, see Amazon ECS Deployment Types 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.*;
 CfnPrimaryTaskSet cfnPrimaryTaskSet = CfnPrimaryTaskSet.Builder.create(this, "MyCfnPrimaryTaskSet")
         .cluster("cluster")
         .service("service")
         .taskSetId("taskSetId")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-primarytaskset.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnPrimaryTaskSet.Builder	A fluent builder for CfnPrimaryTaskSet.

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

software.amazon.jsii.JsiiObject.InitializationMode

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

software.constructs.IConstruct.Jsii$Default

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnPrimaryTaskSet(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnPrimaryTaskSet(software.amazon.jsii.JsiiObjectRef objRef)
	CfnPrimaryTaskSet(software.constructs.Construct scope, String id, CfnPrimaryTaskSetProps props)

Method Summary

Modifier and Type	Method	Description
protected Map<String,Object>	getCfnProperties()
String	getCluster()	The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task set exists in.
String	getService()	The short name or full Amazon Resource Name (ARN) of the service that the task set exists in.
String	getTaskSetId()	The short name or full Amazon Resource Name (ARN) of the task set to set as the primary task set in the deployment.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setCluster(String value)	The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task set exists in.
void	setService(String value)	The short name or full Amazon Resource Name (ARN) of the service that the task set exists in.
void	setTaskSetId(String value)	The short name or full Amazon Resource Name (ARN) of the task set to set as the primary task set in the deployment.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, 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 Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnPrimaryTaskSet

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

CfnPrimaryTaskSet

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

CfnPrimaryTaskSet

@Stability(Stable)
public CfnPrimaryTaskSet(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnPrimaryTaskSetProps props)

Parameters:

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

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

inspect

@Stability(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(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getCluster

@Stability(Stable)
@NotNull
public String getCluster()

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task set exists in.

setCluster

@Stability(Stable)
public void setCluster(@NotNull
 String value)

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task set exists in.

getService

@Stability(Stable)
@NotNull
public String getService()

The short name or full Amazon Resource Name (ARN) of the service that the task set exists in.

setService

@Stability(Stable)
public void setService(@NotNull
 String value)

The short name or full Amazon Resource Name (ARN) of the service that the task set exists in.

getTaskSetId

@Stability(Stable)
@NotNull
public String getTaskSetId()

The short name or full Amazon Resource Name (ARN) of the task set to set as the primary task set in the deployment.

setTaskSetId

@Stability(Stable)
public void setTaskSetId(@NotNull
 String value)

The short name or full Amazon Resource Name (ARN) of the task set to set as the primary task set in the deployment.