com.pulumi.aws.cloudwatch.inputs.EventTargetEcsTargetArgs Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws Show documentation
Show all versions of aws Show documentation
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
// *** WARNING: this file was generated by pulumi-java-gen. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
package com.pulumi.aws.cloudwatch.inputs;
import com.pulumi.aws.cloudwatch.inputs.EventTargetEcsTargetCapacityProviderStrategyArgs;
import com.pulumi.aws.cloudwatch.inputs.EventTargetEcsTargetNetworkConfigurationArgs;
import com.pulumi.aws.cloudwatch.inputs.EventTargetEcsTargetOrderedPlacementStrategyArgs;
import com.pulumi.aws.cloudwatch.inputs.EventTargetEcsTargetPlacementConstraintArgs;
import com.pulumi.core.Output;
import com.pulumi.core.annotations.Import;
import com.pulumi.exceptions.MissingRequiredPropertyException;
import java.lang.Boolean;
import java.lang.Integer;
import java.lang.String;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import javax.annotation.Nullable;
public final class EventTargetEcsTargetArgs extends com.pulumi.resources.ResourceArgs {
public static final EventTargetEcsTargetArgs Empty = new EventTargetEcsTargetArgs();
/**
* The capacity provider strategy to use for the task. If a `capacity_provider_strategy` specified, the `launch_type` parameter must be omitted. If no `capacity_provider_strategy` or `launch_type` is specified, the default capacity provider strategy for the cluster is used. Can be one or more. See below.
*
*/
@Import(name="capacityProviderStrategies")
private @Nullable Output> capacityProviderStrategies;
/**
* @return The capacity provider strategy to use for the task. If a `capacity_provider_strategy` specified, the `launch_type` parameter must be omitted. If no `capacity_provider_strategy` or `launch_type` is specified, the default capacity provider strategy for the cluster is used. Can be one or more. See below.
*
*/
public Optional>> capacityProviderStrategies() {
return Optional.ofNullable(this.capacityProviderStrategies);
}
/**
* Specifies whether to enable Amazon ECS managed tags for the task.
*
*/
@Import(name="enableEcsManagedTags")
private @Nullable Output enableEcsManagedTags;
/**
* @return Specifies whether to enable Amazon ECS managed tags for the task.
*
*/
public Optional> enableEcsManagedTags() {
return Optional.ofNullable(this.enableEcsManagedTags);
}
/**
* Whether or not to enable the execute command functionality for the containers in this task. If true, this enables execute command functionality on all containers in the task.
*
*/
@Import(name="enableExecuteCommand")
private @Nullable Output enableExecuteCommand;
/**
* @return Whether or not to enable the execute command functionality for the containers in this task. If true, this enables execute command functionality on all containers in the task.
*
*/
public Optional> enableExecuteCommand() {
return Optional.ofNullable(this.enableExecuteCommand);
}
/**
* Specifies an ECS task group for the task. The maximum length is 255 characters.
*
*/
@Import(name="group")
private @Nullable Output group;
/**
* @return Specifies an ECS task group for the task. The maximum length is 255 characters.
*
*/
public Optional> group() {
return Optional.ofNullable(this.group);
}
/**
* Specifies the launch type on which your task is running. The launch type that you specify here must match one of the launch type (compatibilities) of the target task. Valid values include: `EC2`, `EXTERNAL`, or `FARGATE`.
*
*/
@Import(name="launchType")
private @Nullable Output launchType;
/**
* @return Specifies the launch type on which your task is running. The launch type that you specify here must match one of the launch type (compatibilities) of the target task. Valid values include: `EC2`, `EXTERNAL`, or `FARGATE`.
*
*/
public Optional> launchType() {
return Optional.ofNullable(this.launchType);
}
/**
* Use this if the ECS task uses the awsvpc network mode. This specifies the VPC subnets and security groups associated with the task, and whether a public IP address is to be used. Required if `launch_type` is `FARGATE` because the awsvpc mode is required for Fargate tasks.
*
*/
@Import(name="networkConfiguration")
private @Nullable Output networkConfiguration;
/**
* @return Use this if the ECS task uses the awsvpc network mode. This specifies the VPC subnets and security groups associated with the task, and whether a public IP address is to be used. Required if `launch_type` is `FARGATE` because the awsvpc mode is required for Fargate tasks.
*
*/
public Optional> networkConfiguration() {
return Optional.ofNullable(this.networkConfiguration);
}
/**
* An array of placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.
*
*/
@Import(name="orderedPlacementStrategies")
private @Nullable Output> orderedPlacementStrategies;
/**
* @return An array of placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.
*
*/
public Optional>> orderedPlacementStrategies() {
return Optional.ofNullable(this.orderedPlacementStrategies);
}
/**
* An array of placement constraint objects to use for the task. You can specify up to 10 constraints per task (including constraints in the task definition and those specified at runtime). See Below.
*
*/
@Import(name="placementConstraints")
private @Nullable Output> placementConstraints;
/**
* @return An array of placement constraint objects to use for the task. You can specify up to 10 constraints per task (including constraints in the task definition and those specified at runtime). See Below.
*
*/
public Optional>> placementConstraints() {
return Optional.ofNullable(this.placementConstraints);
}
/**
* Specifies the platform version for the task. Specify only the numeric portion of the platform version, such as `1.1.0`. This is used only if LaunchType is FARGATE. For more information about valid platform versions, see [AWS Fargate Platform Versions](http://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html).
*
*/
@Import(name="platformVersion")
private @Nullable Output platformVersion;
/**
* @return Specifies the platform version for the task. Specify only the numeric portion of the platform version, such as `1.1.0`. This is used only if LaunchType is FARGATE. For more information about valid platform versions, see [AWS Fargate Platform Versions](http://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html).
*
*/
public Optional> platformVersion() {
return Optional.ofNullable(this.platformVersion);
}
/**
* Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags are not propagated. Tags can only be propagated to the task during task creation. The only valid value is: `TASK_DEFINITION`.
*
*/
@Import(name="propagateTags")
private @Nullable Output propagateTags;
/**
* @return Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags are not propagated. Tags can only be propagated to the task during task creation. The only valid value is: `TASK_DEFINITION`.
*
*/
public Optional> propagateTags() {
return Optional.ofNullable(this.propagateTags);
}
/**
* A map of tags to assign to ecs resources.
*
*/
@Import(name="tags")
private @Nullable Output> tags;
/**
* @return A map of tags to assign to ecs resources.
*
*/
public Optional>> tags() {
return Optional.ofNullable(this.tags);
}
/**
* The number of tasks to create based on the TaskDefinition. Defaults to `1`.
*
*/
@Import(name="taskCount")
private @Nullable Output taskCount;
/**
* @return The number of tasks to create based on the TaskDefinition. Defaults to `1`.
*
*/
public Optional> taskCount() {
return Optional.ofNullable(this.taskCount);
}
/**
* The ARN of the task definition to use if the event target is an Amazon ECS cluster.
*
*/
@Import(name="taskDefinitionArn", required=true)
private Output taskDefinitionArn;
/**
* @return The ARN of the task definition to use if the event target is an Amazon ECS cluster.
*
*/
public Output taskDefinitionArn() {
return this.taskDefinitionArn;
}
private EventTargetEcsTargetArgs() {}
private EventTargetEcsTargetArgs(EventTargetEcsTargetArgs $) {
this.capacityProviderStrategies = $.capacityProviderStrategies;
this.enableEcsManagedTags = $.enableEcsManagedTags;
this.enableExecuteCommand = $.enableExecuteCommand;
this.group = $.group;
this.launchType = $.launchType;
this.networkConfiguration = $.networkConfiguration;
this.orderedPlacementStrategies = $.orderedPlacementStrategies;
this.placementConstraints = $.placementConstraints;
this.platformVersion = $.platformVersion;
this.propagateTags = $.propagateTags;
this.tags = $.tags;
this.taskCount = $.taskCount;
this.taskDefinitionArn = $.taskDefinitionArn;
}
public static Builder builder() {
return new Builder();
}
public static Builder builder(EventTargetEcsTargetArgs defaults) {
return new Builder(defaults);
}
public static final class Builder {
private EventTargetEcsTargetArgs $;
public Builder() {
$ = new EventTargetEcsTargetArgs();
}
public Builder(EventTargetEcsTargetArgs defaults) {
$ = new EventTargetEcsTargetArgs(Objects.requireNonNull(defaults));
}
/**
* @param capacityProviderStrategies The capacity provider strategy to use for the task. If a `capacity_provider_strategy` specified, the `launch_type` parameter must be omitted. If no `capacity_provider_strategy` or `launch_type` is specified, the default capacity provider strategy for the cluster is used. Can be one or more. See below.
*
* @return builder
*
*/
public Builder capacityProviderStrategies(@Nullable Output> capacityProviderStrategies) {
$.capacityProviderStrategies = capacityProviderStrategies;
return this;
}
/**
* @param capacityProviderStrategies The capacity provider strategy to use for the task. If a `capacity_provider_strategy` specified, the `launch_type` parameter must be omitted. If no `capacity_provider_strategy` or `launch_type` is specified, the default capacity provider strategy for the cluster is used. Can be one or more. See below.
*
* @return builder
*
*/
public Builder capacityProviderStrategies(List capacityProviderStrategies) {
return capacityProviderStrategies(Output.of(capacityProviderStrategies));
}
/**
* @param capacityProviderStrategies The capacity provider strategy to use for the task. If a `capacity_provider_strategy` specified, the `launch_type` parameter must be omitted. If no `capacity_provider_strategy` or `launch_type` is specified, the default capacity provider strategy for the cluster is used. Can be one or more. See below.
*
* @return builder
*
*/
public Builder capacityProviderStrategies(EventTargetEcsTargetCapacityProviderStrategyArgs... capacityProviderStrategies) {
return capacityProviderStrategies(List.of(capacityProviderStrategies));
}
/**
* @param enableEcsManagedTags Specifies whether to enable Amazon ECS managed tags for the task.
*
* @return builder
*
*/
public Builder enableEcsManagedTags(@Nullable Output enableEcsManagedTags) {
$.enableEcsManagedTags = enableEcsManagedTags;
return this;
}
/**
* @param enableEcsManagedTags Specifies whether to enable Amazon ECS managed tags for the task.
*
* @return builder
*
*/
public Builder enableEcsManagedTags(Boolean enableEcsManagedTags) {
return enableEcsManagedTags(Output.of(enableEcsManagedTags));
}
/**
* @param enableExecuteCommand Whether or not to enable the execute command functionality for the containers in this task. If true, this enables execute command functionality on all containers in the task.
*
* @return builder
*
*/
public Builder enableExecuteCommand(@Nullable Output enableExecuteCommand) {
$.enableExecuteCommand = enableExecuteCommand;
return this;
}
/**
* @param enableExecuteCommand Whether or not to enable the execute command functionality for the containers in this task. If true, this enables execute command functionality on all containers in the task.
*
* @return builder
*
*/
public Builder enableExecuteCommand(Boolean enableExecuteCommand) {
return enableExecuteCommand(Output.of(enableExecuteCommand));
}
/**
* @param group Specifies an ECS task group for the task. The maximum length is 255 characters.
*
* @return builder
*
*/
public Builder group(@Nullable Output group) {
$.group = group;
return this;
}
/**
* @param group Specifies an ECS task group for the task. The maximum length is 255 characters.
*
* @return builder
*
*/
public Builder group(String group) {
return group(Output.of(group));
}
/**
* @param launchType Specifies the launch type on which your task is running. The launch type that you specify here must match one of the launch type (compatibilities) of the target task. Valid values include: `EC2`, `EXTERNAL`, or `FARGATE`.
*
* @return builder
*
*/
public Builder launchType(@Nullable Output launchType) {
$.launchType = launchType;
return this;
}
/**
* @param launchType Specifies the launch type on which your task is running. The launch type that you specify here must match one of the launch type (compatibilities) of the target task. Valid values include: `EC2`, `EXTERNAL`, or `FARGATE`.
*
* @return builder
*
*/
public Builder launchType(String launchType) {
return launchType(Output.of(launchType));
}
/**
* @param networkConfiguration Use this if the ECS task uses the awsvpc network mode. This specifies the VPC subnets and security groups associated with the task, and whether a public IP address is to be used. Required if `launch_type` is `FARGATE` because the awsvpc mode is required for Fargate tasks.
*
* @return builder
*
*/
public Builder networkConfiguration(@Nullable Output networkConfiguration) {
$.networkConfiguration = networkConfiguration;
return this;
}
/**
* @param networkConfiguration Use this if the ECS task uses the awsvpc network mode. This specifies the VPC subnets and security groups associated with the task, and whether a public IP address is to be used. Required if `launch_type` is `FARGATE` because the awsvpc mode is required for Fargate tasks.
*
* @return builder
*
*/
public Builder networkConfiguration(EventTargetEcsTargetNetworkConfigurationArgs networkConfiguration) {
return networkConfiguration(Output.of(networkConfiguration));
}
/**
* @param orderedPlacementStrategies An array of placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.
*
* @return builder
*
*/
public Builder orderedPlacementStrategies(@Nullable Output> orderedPlacementStrategies) {
$.orderedPlacementStrategies = orderedPlacementStrategies;
return this;
}
/**
* @param orderedPlacementStrategies An array of placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.
*
* @return builder
*
*/
public Builder orderedPlacementStrategies(List orderedPlacementStrategies) {
return orderedPlacementStrategies(Output.of(orderedPlacementStrategies));
}
/**
* @param orderedPlacementStrategies An array of placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.
*
* @return builder
*
*/
public Builder orderedPlacementStrategies(EventTargetEcsTargetOrderedPlacementStrategyArgs... orderedPlacementStrategies) {
return orderedPlacementStrategies(List.of(orderedPlacementStrategies));
}
/**
* @param placementConstraints An array of placement constraint objects to use for the task. You can specify up to 10 constraints per task (including constraints in the task definition and those specified at runtime). See Below.
*
* @return builder
*
*/
public Builder placementConstraints(@Nullable Output> placementConstraints) {
$.placementConstraints = placementConstraints;
return this;
}
/**
* @param placementConstraints An array of placement constraint objects to use for the task. You can specify up to 10 constraints per task (including constraints in the task definition and those specified at runtime). See Below.
*
* @return builder
*
*/
public Builder placementConstraints(List placementConstraints) {
return placementConstraints(Output.of(placementConstraints));
}
/**
* @param placementConstraints An array of placement constraint objects to use for the task. You can specify up to 10 constraints per task (including constraints in the task definition and those specified at runtime). See Below.
*
* @return builder
*
*/
public Builder placementConstraints(EventTargetEcsTargetPlacementConstraintArgs... placementConstraints) {
return placementConstraints(List.of(placementConstraints));
}
/**
* @param platformVersion Specifies the platform version for the task. Specify only the numeric portion of the platform version, such as `1.1.0`. This is used only if LaunchType is FARGATE. For more information about valid platform versions, see [AWS Fargate Platform Versions](http://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html).
*
* @return builder
*
*/
public Builder platformVersion(@Nullable Output platformVersion) {
$.platformVersion = platformVersion;
return this;
}
/**
* @param platformVersion Specifies the platform version for the task. Specify only the numeric portion of the platform version, such as `1.1.0`. This is used only if LaunchType is FARGATE. For more information about valid platform versions, see [AWS Fargate Platform Versions](http://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html).
*
* @return builder
*
*/
public Builder platformVersion(String platformVersion) {
return platformVersion(Output.of(platformVersion));
}
/**
* @param propagateTags Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags are not propagated. Tags can only be propagated to the task during task creation. The only valid value is: `TASK_DEFINITION`.
*
* @return builder
*
*/
public Builder propagateTags(@Nullable Output propagateTags) {
$.propagateTags = propagateTags;
return this;
}
/**
* @param propagateTags Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags are not propagated. Tags can only be propagated to the task during task creation. The only valid value is: `TASK_DEFINITION`.
*
* @return builder
*
*/
public Builder propagateTags(String propagateTags) {
return propagateTags(Output.of(propagateTags));
}
/**
* @param tags A map of tags to assign to ecs resources.
*
* @return builder
*
*/
public Builder tags(@Nullable Output> tags) {
$.tags = tags;
return this;
}
/**
* @param tags A map of tags to assign to ecs resources.
*
* @return builder
*
*/
public Builder tags(Map tags) {
return tags(Output.of(tags));
}
/**
* @param taskCount The number of tasks to create based on the TaskDefinition. Defaults to `1`.
*
* @return builder
*
*/
public Builder taskCount(@Nullable Output taskCount) {
$.taskCount = taskCount;
return this;
}
/**
* @param taskCount The number of tasks to create based on the TaskDefinition. Defaults to `1`.
*
* @return builder
*
*/
public Builder taskCount(Integer taskCount) {
return taskCount(Output.of(taskCount));
}
/**
* @param taskDefinitionArn The ARN of the task definition to use if the event target is an Amazon ECS cluster.
*
* @return builder
*
*/
public Builder taskDefinitionArn(Output taskDefinitionArn) {
$.taskDefinitionArn = taskDefinitionArn;
return this;
}
/**
* @param taskDefinitionArn The ARN of the task definition to use if the event target is an Amazon ECS cluster.
*
* @return builder
*
*/
public Builder taskDefinitionArn(String taskDefinitionArn) {
return taskDefinitionArn(Output.of(taskDefinitionArn));
}
public EventTargetEcsTargetArgs build() {
if ($.taskDefinitionArn == null) {
throw new MissingRequiredPropertyException("EventTargetEcsTargetArgs", "taskDefinitionArn");
}
return $;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy