Class CfnServiceMixinProps.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnServiceMixinProps>
- Enclosing interface:
CfnServiceMixinProps
CfnServiceMixinProps-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionavailabilityZoneRebalancing(String availabilityZoneRebalancing) Sets the value ofCfnServiceMixinProps.getAvailabilityZoneRebalancing()build()Builds the configured instance.capacityProviderStrategy(List<? extends Object> capacityProviderStrategy) Sets the value ofCfnServiceMixinProps.getCapacityProviderStrategy()capacityProviderStrategy(IResolvable capacityProviderStrategy) Sets the value ofCfnServiceMixinProps.getCapacityProviderStrategy()Sets the value ofCfnServiceMixinProps.getCluster()cluster(IClusterRef cluster) Sets the value ofCfnServiceMixinProps.getCluster()deploymentConfiguration(CfnServicePropsMixin.DeploymentConfigurationProperty deploymentConfiguration) Sets the value ofCfnServiceMixinProps.getDeploymentConfiguration()deploymentConfiguration(IResolvable deploymentConfiguration) Sets the value ofCfnServiceMixinProps.getDeploymentConfiguration()deploymentController(CfnServicePropsMixin.DeploymentControllerProperty deploymentController) Sets the value ofCfnServiceMixinProps.getDeploymentController()deploymentController(IResolvable deploymentController) Sets the value ofCfnServiceMixinProps.getDeploymentController()desiredCount(Number desiredCount) Sets the value ofCfnServiceMixinProps.getDesiredCount()enableEcsManagedTags(Boolean enableEcsManagedTags) Sets the value ofCfnServiceMixinProps.getEnableEcsManagedTags()enableEcsManagedTags(IResolvable enableEcsManagedTags) Sets the value ofCfnServiceMixinProps.getEnableEcsManagedTags()enableExecuteCommand(Boolean enableExecuteCommand) Sets the value ofCfnServiceMixinProps.getEnableExecuteCommand()enableExecuteCommand(IResolvable enableExecuteCommand) Sets the value ofCfnServiceMixinProps.getEnableExecuteCommand()forceNewDeployment(CfnServicePropsMixin.ForceNewDeploymentProperty forceNewDeployment) Sets the value ofCfnServiceMixinProps.getForceNewDeployment()forceNewDeployment(IResolvable forceNewDeployment) Sets the value ofCfnServiceMixinProps.getForceNewDeployment()healthCheckGracePeriodSeconds(Number healthCheckGracePeriodSeconds) Sets the value ofCfnServiceMixinProps.getHealthCheckGracePeriodSeconds()launchType(String launchType) Sets the value ofCfnServiceMixinProps.getLaunchType()loadBalancers(List<? extends Object> loadBalancers) Sets the value ofCfnServiceMixinProps.getLoadBalancers()loadBalancers(IResolvable loadBalancers) Sets the value ofCfnServiceMixinProps.getLoadBalancers()networkConfiguration(CfnServicePropsMixin.NetworkConfigurationProperty networkConfiguration) Sets the value ofCfnServiceMixinProps.getNetworkConfiguration()networkConfiguration(IResolvable networkConfiguration) Sets the value ofCfnServiceMixinProps.getNetworkConfiguration()placementConstraints(List<? extends Object> placementConstraints) Sets the value ofCfnServiceMixinProps.getPlacementConstraints()placementConstraints(IResolvable placementConstraints) Sets the value ofCfnServiceMixinProps.getPlacementConstraints()placementStrategies(List<? extends Object> placementStrategies) Sets the value ofCfnServiceMixinProps.getPlacementStrategies()placementStrategies(IResolvable placementStrategies) Sets the value ofCfnServiceMixinProps.getPlacementStrategies()platformVersion(String platformVersion) Sets the value ofCfnServiceMixinProps.getPlatformVersion()propagateTags(String propagateTags) Sets the value ofCfnServiceMixinProps.getPropagateTags()Sets the value ofCfnServiceMixinProps.getRole()Sets the value ofCfnServiceMixinProps.getRole()schedulingStrategy(String schedulingStrategy) Sets the value ofCfnServiceMixinProps.getSchedulingStrategy()serviceConnectConfiguration(CfnServicePropsMixin.ServiceConnectConfigurationProperty serviceConnectConfiguration) Sets the value ofCfnServiceMixinProps.getServiceConnectConfiguration()serviceConnectConfiguration(IResolvable serviceConnectConfiguration) Sets the value ofCfnServiceMixinProps.getServiceConnectConfiguration()serviceName(String serviceName) Sets the value ofCfnServiceMixinProps.getServiceName()serviceRegistries(List<? extends Object> serviceRegistries) Sets the value ofCfnServiceMixinProps.getServiceRegistries()serviceRegistries(IResolvable serviceRegistries) Sets the value ofCfnServiceMixinProps.getServiceRegistries()Sets the value ofCfnServiceMixinProps.getTags()taskDefinition(String taskDefinition) Sets the value ofCfnServiceMixinProps.getTaskDefinition()taskDefinition(ITaskDefinitionRef taskDefinition) Sets the value ofCfnServiceMixinProps.getTaskDefinition()volumeConfigurations(List<? extends Object> volumeConfigurations) Sets the value ofCfnServiceMixinProps.getVolumeConfigurations()volumeConfigurations(IResolvable volumeConfigurations) Sets the value ofCfnServiceMixinProps.getVolumeConfigurations()vpcLatticeConfigurations(List<? extends Object> vpcLatticeConfigurations) Sets the value ofCfnServiceMixinProps.getVpcLatticeConfigurations()vpcLatticeConfigurations(IResolvable vpcLatticeConfigurations) Sets the value ofCfnServiceMixinProps.getVpcLatticeConfigurations()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
availabilityZoneRebalancing
@Stability(Stable) public CfnServiceMixinProps.Builder availabilityZoneRebalancing(String availabilityZoneRebalancing) Sets the value ofCfnServiceMixinProps.getAvailabilityZoneRebalancing()- Parameters:
availabilityZoneRebalancing- Indicates whether to use Availability Zone rebalancing for the service. For more information, see Balancing an Amazon ECS service across Availability Zones in the Amazon Elastic Container Service Developer Guide .The default behavior of
AvailabilityZoneRebalancingdiffers between create and update requests:- For create service requests, when no value is specified for
AvailabilityZoneRebalancing, Amazon ECS defaults the value toENABLED. - For update service requests, when no value is specified for
AvailabilityZoneRebalancing, Amazon ECS defaults to the existing service’sAvailabilityZoneRebalancingvalue. If the service never had anAvailabilityZoneRebalancingvalue set, Amazon ECS treats this asDISABLED.
- For create service requests, when no value is specified for
- Returns:
this
-
capacityProviderStrategy
@Stability(Stable) public CfnServiceMixinProps.Builder capacityProviderStrategy(IResolvable capacityProviderStrategy) Sets the value ofCfnServiceMixinProps.getCapacityProviderStrategy()- Parameters:
capacityProviderStrategy- The capacity provider strategy to use for the service. If acapacityProviderStrategyis specified, thelaunchTypeparameter must be omitted. If nocapacityProviderStrategyorlaunchTypeis specified, thedefaultCapacityProviderStrategyfor the cluster is used.A capacity provider strategy can contain a maximum of 20 capacity providers.
To remove this property from your service resource, specify an empty
CapacityProviderStrategyItemarray.- Returns:
this
-
capacityProviderStrategy
@Stability(Stable) public CfnServiceMixinProps.Builder capacityProviderStrategy(List<? extends Object> capacityProviderStrategy) Sets the value ofCfnServiceMixinProps.getCapacityProviderStrategy()- Parameters:
capacityProviderStrategy- The capacity provider strategy to use for the service. If acapacityProviderStrategyis specified, thelaunchTypeparameter must be omitted. If nocapacityProviderStrategyorlaunchTypeis specified, thedefaultCapacityProviderStrategyfor the cluster is used.A capacity provider strategy can contain a maximum of 20 capacity providers.
To remove this property from your service resource, specify an empty
CapacityProviderStrategyItemarray.- Returns:
this
-
cluster
Sets the value ofCfnServiceMixinProps.getCluster()- Parameters:
cluster- The short name or full Amazon Resource Name (ARN) of the cluster that you run your service on. If you do not specify a cluster, the default cluster is assumed.- Returns:
this
-
cluster
Sets the value ofCfnServiceMixinProps.getCluster()- Parameters:
cluster- The short name or full Amazon Resource Name (ARN) of the cluster that you run your service on. If you do not specify a cluster, the default cluster is assumed.- Returns:
this
-
deploymentConfiguration
@Stability(Stable) public CfnServiceMixinProps.Builder deploymentConfiguration(IResolvable deploymentConfiguration) Sets the value ofCfnServiceMixinProps.getDeploymentConfiguration()- Parameters:
deploymentConfiguration- Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.- Returns:
this
-
deploymentConfiguration
@Stability(Stable) public CfnServiceMixinProps.Builder deploymentConfiguration(CfnServicePropsMixin.DeploymentConfigurationProperty deploymentConfiguration) Sets the value ofCfnServiceMixinProps.getDeploymentConfiguration()- Parameters:
deploymentConfiguration- Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.- Returns:
this
-
deploymentController
@Stability(Stable) public CfnServiceMixinProps.Builder deploymentController(IResolvable deploymentController) Sets the value ofCfnServiceMixinProps.getDeploymentController()- Parameters:
deploymentController- The deployment controller to use for the service.- Returns:
this
-
deploymentController
@Stability(Stable) public CfnServiceMixinProps.Builder deploymentController(CfnServicePropsMixin.DeploymentControllerProperty deploymentController) Sets the value ofCfnServiceMixinProps.getDeploymentController()- Parameters:
deploymentController- The deployment controller to use for the service.- Returns:
this
-
desiredCount
Sets the value ofCfnServiceMixinProps.getDesiredCount()- Parameters:
desiredCount- The number of instantiations of the specified task definition to place and keep running in your service. For new services, if a desired count is not specified, a default value of1is used. When using theDAEMONscheduling strategy, the desired count is not required.For existing services, if a desired count is not specified, it is omitted from the operation.
- Returns:
this
-
enableEcsManagedTags
@Stability(Stable) public CfnServiceMixinProps.Builder enableEcsManagedTags(Boolean enableEcsManagedTags) Sets the value ofCfnServiceMixinProps.getEnableEcsManagedTags()- Parameters:
enableEcsManagedTags- Specifies whether to turn on Amazon ECS managed tags for the tasks within the service. For more information, see Tagging your Amazon ECS resources in the Amazon Elastic Container Service Developer Guide .When you use Amazon ECS managed tags, you must set the
propagateTagsrequest parameter.- Returns:
this
-
enableEcsManagedTags
@Stability(Stable) public CfnServiceMixinProps.Builder enableEcsManagedTags(IResolvable enableEcsManagedTags) Sets the value ofCfnServiceMixinProps.getEnableEcsManagedTags()- Parameters:
enableEcsManagedTags- Specifies whether to turn on Amazon ECS managed tags for the tasks within the service. For more information, see Tagging your Amazon ECS resources in the Amazon Elastic Container Service Developer Guide .When you use Amazon ECS managed tags, you must set the
propagateTagsrequest parameter.- Returns:
this
-
enableExecuteCommand
@Stability(Stable) public CfnServiceMixinProps.Builder enableExecuteCommand(Boolean enableExecuteCommand) Sets the value ofCfnServiceMixinProps.getEnableExecuteCommand()- Parameters:
enableExecuteCommand- Determines whether the execute command functionality is turned on for the service. Iftrue, the execute command functionality is turned on for all containers in tasks as part of the service.- Returns:
this
-
enableExecuteCommand
@Stability(Stable) public CfnServiceMixinProps.Builder enableExecuteCommand(IResolvable enableExecuteCommand) Sets the value ofCfnServiceMixinProps.getEnableExecuteCommand()- Parameters:
enableExecuteCommand- Determines whether the execute command functionality is turned on for the service. Iftrue, the execute command functionality is turned on for all containers in tasks as part of the service.- Returns:
this
-
forceNewDeployment
@Stability(Stable) public CfnServiceMixinProps.Builder forceNewDeployment(IResolvable forceNewDeployment) Sets the value ofCfnServiceMixinProps.getForceNewDeployment()- Parameters:
forceNewDeployment- Determines whether to force a new deployment of the service. By default, deployments aren't forced. You can use this option to start a new deployment with no service definition changes. For example, you can update a service's tasks to use a newer Docker image with the same image/tag combination (my_image:latest) or to roll Fargate tasks onto a newer platform version.- Returns:
this
-
forceNewDeployment
@Stability(Stable) public CfnServiceMixinProps.Builder forceNewDeployment(CfnServicePropsMixin.ForceNewDeploymentProperty forceNewDeployment) Sets the value ofCfnServiceMixinProps.getForceNewDeployment()- Parameters:
forceNewDeployment- Determines whether to force a new deployment of the service. By default, deployments aren't forced. You can use this option to start a new deployment with no service definition changes. For example, you can update a service's tasks to use a newer Docker image with the same image/tag combination (my_image:latest) or to roll Fargate tasks onto a newer platform version.- Returns:
this
-
healthCheckGracePeriodSeconds
@Stability(Stable) public CfnServiceMixinProps.Builder healthCheckGracePeriodSeconds(Number healthCheckGracePeriodSeconds) Sets the value ofCfnServiceMixinProps.getHealthCheckGracePeriodSeconds()- Parameters:
healthCheckGracePeriodSeconds- The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing, VPC Lattice, and container health checks after a task has first started. If you do not specify a health check grace period value, the default value of 0 is used. If you do not use any of the health checks, thenhealthCheckGracePeriodSecondsis unused.If your service has more running tasks than desired, unhealthy tasks in the grace period might be stopped to reach the desired count.
- Returns:
this
-
launchType
Sets the value ofCfnServiceMixinProps.getLaunchType()- Parameters:
launchType- The launch type on which to run your service. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide .If you want to use Managed Instances, you must use the
capacityProviderStrategyrequest parameter- Returns:
this
-
loadBalancers
Sets the value ofCfnServiceMixinProps.getLoadBalancers()- Parameters:
loadBalancers- A list of load balancer objects to associate with the service. If you specify theRoleproperty,LoadBalancersmust be specified as well. For information about the number of load balancers that you can specify per service, see Service Load Balancing in the Amazon Elastic Container Service Developer Guide .To remove this property from your service resource, specify an empty
LoadBalancerarray.- Returns:
this
-
loadBalancers
@Stability(Stable) public CfnServiceMixinProps.Builder loadBalancers(List<? extends Object> loadBalancers) Sets the value ofCfnServiceMixinProps.getLoadBalancers()- Parameters:
loadBalancers- A list of load balancer objects to associate with the service. If you specify theRoleproperty,LoadBalancersmust be specified as well. For information about the number of load balancers that you can specify per service, see Service Load Balancing in the Amazon Elastic Container Service Developer Guide .To remove this property from your service resource, specify an empty
LoadBalancerarray.- Returns:
this
-
networkConfiguration
@Stability(Stable) public CfnServiceMixinProps.Builder networkConfiguration(IResolvable networkConfiguration) Sets the value ofCfnServiceMixinProps.getNetworkConfiguration()- Parameters:
networkConfiguration- The network configuration for the service. This parameter is required for task definitions that use theawsvpcnetwork mode to receive their own elastic network interface, and it is not supported for other network modes. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide .- Returns:
this
-
networkConfiguration
@Stability(Stable) public CfnServiceMixinProps.Builder networkConfiguration(CfnServicePropsMixin.NetworkConfigurationProperty networkConfiguration) Sets the value ofCfnServiceMixinProps.getNetworkConfiguration()- Parameters:
networkConfiguration- The network configuration for the service. This parameter is required for task definitions that use theawsvpcnetwork mode to receive their own elastic network interface, and it is not supported for other network modes. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide .- Returns:
this
-
placementConstraints
@Stability(Stable) public CfnServiceMixinProps.Builder placementConstraints(IResolvable placementConstraints) Sets the value ofCfnServiceMixinProps.getPlacementConstraints()- Parameters:
placementConstraints- An array of placement constraint objects to use for tasks in your service. You can specify a maximum of 10 constraints for each task. This limit includes constraints in the task definition and those specified at runtime.To remove this property from your service resource, specify an empty
PlacementConstraintarray.- Returns:
this
-
placementConstraints
@Stability(Stable) public CfnServiceMixinProps.Builder placementConstraints(List<? extends Object> placementConstraints) Sets the value ofCfnServiceMixinProps.getPlacementConstraints()- Parameters:
placementConstraints- An array of placement constraint objects to use for tasks in your service. You can specify a maximum of 10 constraints for each task. This limit includes constraints in the task definition and those specified at runtime.To remove this property from your service resource, specify an empty
PlacementConstraintarray.- Returns:
this
-
placementStrategies
@Stability(Stable) public CfnServiceMixinProps.Builder placementStrategies(IResolvable placementStrategies) Sets the value ofCfnServiceMixinProps.getPlacementStrategies()- Parameters:
placementStrategies- The placement strategy objects to use for tasks in your service. You can specify a maximum of 5 strategy rules for each service.To remove this property from your service resource, specify an empty
PlacementStrategyarray.- Returns:
this
-
placementStrategies
@Stability(Stable) public CfnServiceMixinProps.Builder placementStrategies(List<? extends Object> placementStrategies) Sets the value ofCfnServiceMixinProps.getPlacementStrategies()- Parameters:
placementStrategies- The placement strategy objects to use for tasks in your service. You can specify a maximum of 5 strategy rules for each service.To remove this property from your service resource, specify an empty
PlacementStrategyarray.- Returns:
this
-
platformVersion
Sets the value ofCfnServiceMixinProps.getPlatformVersion()- Parameters:
platformVersion- The platform version that your tasks in the service are running on. A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, theLATESTplatform version is used. For more information, see AWS Fargate platform versions in the Amazon Elastic Container Service Developer Guide .- Returns:
this
-
propagateTags
Sets the value ofCfnServiceMixinProps.getPropagateTags()- Parameters:
propagateTags- Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the TagResource API action.You must set this to a value other than
NONEwhen you use Cost Explorer. For more information, see Amazon ECS usage reports in the Amazon Elastic Container Service Developer Guide .The default is
NONE.- Returns:
this
-
role
Sets the value ofCfnServiceMixinProps.getRole()- Parameters:
role- The name or full Amazon Resource Name (ARN) of the IAM role that allows Amazon ECS to make calls to your load balancer on your behalf. This parameter is only permitted if you are using a load balancer with your service and your task definition doesn't use theawsvpcnetwork mode. If you specify theroleparameter, you must also specify a load balancer object with theloadBalancersparameter.If your account has already created the Amazon ECS service-linked role, that role is used for your service unless you specify a role here. The service-linked role is required if your task definition uses the
awsvpcnetwork mode or if the service is configured to use service discovery, an external deployment controller, multiple target groups, or Elastic Inference accelerators in which case you don't specify a role here. For more information, see Using service-linked roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide .If your specified role has a path other than
/, then you must either specify the full role ARN (this is recommended) or prefix the role name with the path. For example, if a role with the namebarhas a path of/foo/then you would specify/foo/baras the role name. For more information, see Friendly names and paths in the IAM User Guide .- Returns:
this
-
role
Sets the value ofCfnServiceMixinProps.getRole()- Parameters:
role- The name or full Amazon Resource Name (ARN) of the IAM role that allows Amazon ECS to make calls to your load balancer on your behalf. This parameter is only permitted if you are using a load balancer with your service and your task definition doesn't use theawsvpcnetwork mode. If you specify theroleparameter, you must also specify a load balancer object with theloadBalancersparameter.If your account has already created the Amazon ECS service-linked role, that role is used for your service unless you specify a role here. The service-linked role is required if your task definition uses the
awsvpcnetwork mode or if the service is configured to use service discovery, an external deployment controller, multiple target groups, or Elastic Inference accelerators in which case you don't specify a role here. For more information, see Using service-linked roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide .If your specified role has a path other than
/, then you must either specify the full role ARN (this is recommended) or prefix the role name with the path. For example, if a role with the namebarhas a path of/foo/then you would specify/foo/baras the role name. For more information, see Friendly names and paths in the IAM User Guide .- Returns:
this
-
schedulingStrategy
@Stability(Stable) public CfnServiceMixinProps.Builder schedulingStrategy(String schedulingStrategy) Sets the value ofCfnServiceMixinProps.getSchedulingStrategy()- Parameters:
schedulingStrategy- The scheduling strategy to use for the service. For more information, see Services . There are two service scheduler strategies available:REPLICA-The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions. This scheduler strategy is required if the service uses theCODE_DEPLOYorEXTERNALdeployment controller types.DAEMON-The daemon scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks and will stop tasks that don't meet the placement constraints. When you're using this strategy, you don't need to specify a desired number of tasks, a task placement strategy, or use Service Auto Scaling policies.
Tasks using the Fargate launch type or the
CODE_DEPLOYorEXTERNALdeployment controller types don't support theDAEMONscheduling strategy.- Returns:
this
-
serviceConnectConfiguration
@Stability(Stable) public CfnServiceMixinProps.Builder serviceConnectConfiguration(IResolvable serviceConnectConfiguration) Sets the value ofCfnServiceMixinProps.getServiceConnectConfiguration()- Parameters:
serviceConnectConfiguration- The configuration for this service to discover and connect to services, and be discovered by, and connected from, other services within a namespace. Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide .- Returns:
this
-
serviceConnectConfiguration
@Stability(Stable) public CfnServiceMixinProps.Builder serviceConnectConfiguration(CfnServicePropsMixin.ServiceConnectConfigurationProperty serviceConnectConfiguration) Sets the value ofCfnServiceMixinProps.getServiceConnectConfiguration()- Parameters:
serviceConnectConfiguration- The configuration for this service to discover and connect to services, and be discovered by, and connected from, other services within a namespace. Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide .- Returns:
this
-
serviceName
Sets the value ofCfnServiceMixinProps.getServiceName()- Parameters:
serviceName- The name of your service. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a Region or across multiple Regions.The stack update fails if you change any properties that require replacement and the
ServiceNameis configured. This is because AWS CloudFormation creates the replacement service first, but eachServiceNamemust be unique in the cluster.- Returns:
this
-
serviceRegistries
@Stability(Stable) public CfnServiceMixinProps.Builder serviceRegistries(IResolvable serviceRegistries) Sets the value ofCfnServiceMixinProps.getServiceRegistries()- Parameters:
serviceRegistries- The details of the service discovery registry to associate with this service. For more information, see Service discovery .Each service may be associated with one service registry. Multiple service registries for each service isn't supported. > To remove this property from your service resource, specify an empty
ServiceRegistryarray.- Returns:
this
-
serviceRegistries
@Stability(Stable) public CfnServiceMixinProps.Builder serviceRegistries(List<? extends Object> serviceRegistries) Sets the value ofCfnServiceMixinProps.getServiceRegistries()- Parameters:
serviceRegistries- The details of the service discovery registry to associate with this service. For more information, see Service discovery .Each service may be associated with one service registry. Multiple service registries for each service isn't supported. > To remove this property from your service resource, specify an empty
ServiceRegistryarray.- Returns:
this
-
tags
Sets the value ofCfnServiceMixinProps.getTags()- Parameters:
tags- The metadata that you apply to the service to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. When a service is deleted, the tags are deleted as well.The following basic restrictions apply to tags:
- Maximum number of tags per resource - 50
- For each resource, each tag key must be unique, and each tag key can have only one value.
- Maximum key length - 128 Unicode characters in UTF-8
- Maximum value length - 256 Unicode characters in UTF-8
- If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : /
- Returns:
this
-
taskDefinition
Sets the value ofCfnServiceMixinProps.getTaskDefinition()- Parameters:
taskDefinition- Thefamilyandrevision(family:revision) or full ARN of the task definition to run in your service. If arevisionisn't specified, the latestACTIVErevision is used.A task definition must be specified if the service uses either the
ECSorCODE_DEPLOYdeployment controllers.For more information about deployment types, see Amazon ECS deployment types .
- Returns:
this
-
taskDefinition
@Stability(Stable) public CfnServiceMixinProps.Builder taskDefinition(ITaskDefinitionRef taskDefinition) Sets the value ofCfnServiceMixinProps.getTaskDefinition()- Parameters:
taskDefinition- Thefamilyandrevision(family:revision) or full ARN of the task definition to run in your service. If arevisionisn't specified, the latestACTIVErevision is used.A task definition must be specified if the service uses either the
ECSorCODE_DEPLOYdeployment controllers.For more information about deployment types, see Amazon ECS deployment types .
- Returns:
this
-
volumeConfigurations
@Stability(Stable) public CfnServiceMixinProps.Builder volumeConfigurations(IResolvable volumeConfigurations) Sets the value ofCfnServiceMixinProps.getVolumeConfigurations()- Parameters:
volumeConfigurations- The configuration for a volume specified in the task definition as a volume that is configured at launch time. Currently, the only supported volume type is an Amazon EBS volume.To remove this property from your service resource, specify an empty
ServiceVolumeConfigurationarray.- Returns:
this
-
volumeConfigurations
@Stability(Stable) public CfnServiceMixinProps.Builder volumeConfigurations(List<? extends Object> volumeConfigurations) Sets the value ofCfnServiceMixinProps.getVolumeConfigurations()- Parameters:
volumeConfigurations- The configuration for a volume specified in the task definition as a volume that is configured at launch time. Currently, the only supported volume type is an Amazon EBS volume.To remove this property from your service resource, specify an empty
ServiceVolumeConfigurationarray.- Returns:
this
-
vpcLatticeConfigurations
@Stability(Stable) public CfnServiceMixinProps.Builder vpcLatticeConfigurations(IResolvable vpcLatticeConfigurations) Sets the value ofCfnServiceMixinProps.getVpcLatticeConfigurations()- Parameters:
vpcLatticeConfigurations- The VPC Lattice configuration for the service being created.- Returns:
this
-
vpcLatticeConfigurations
@Stability(Stable) public CfnServiceMixinProps.Builder vpcLatticeConfigurations(List<? extends Object> vpcLatticeConfigurations) Sets the value ofCfnServiceMixinProps.getVpcLatticeConfigurations()- Parameters:
vpcLatticeConfigurations- The VPC Lattice configuration for the service being created.- Returns:
this
-
build
Builds the configured instance.- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<CfnServiceMixinProps>- Returns:
- a new instance of
CfnServiceMixinProps - Throws:
NullPointerException- if any required attribute was not provided
-