1. Packages
  2. Harness
  3. API Docs
  4. service
  5. Ecs
Harness v0.1.1 published on Friday, Jul 12, 2024 by Pulumi

harness.service.Ecs

Explore with Pulumi AI

harness logo
Harness v0.1.1 published on Friday, Jul 12, 2024 by Pulumi

    Resource for creating an AWS ECS service. This resource uses the config-as-code API’s. When updating the name or path of this resource you should typically also set the create_before_destroy = true lifecycle setting.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as harness from "@pulumi/harness";
    
    const example = new harness.Application("example", {name: "example"});
    const exampleEcs = new harness.service.Ecs("example", {
        appId: example.id,
        name: "ecs-example-service",
        description: "Service for deploying AWS ECS tasks.",
    });
    
    import pulumi
    import pulumi_harness as harness
    
    example = harness.Application("example", name="example")
    example_ecs = harness.service.Ecs("example",
        app_id=example.id,
        name="ecs-example-service",
        description="Service for deploying AWS ECS tasks.")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-harness/sdk/go/harness"
    	"github.com/pulumi/pulumi-harness/sdk/go/harness/service"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		example, err := harness.NewApplication(ctx, "example", &harness.ApplicationArgs{
    			Name: pulumi.String("example"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = service.NewEcs(ctx, "example", &service.EcsArgs{
    			AppId:       example.ID(),
    			Name:        pulumi.String("ecs-example-service"),
    			Description: pulumi.String("Service for deploying AWS ECS tasks."),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Harness = Pulumi.Harness;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Harness.Application("example", new()
        {
            Name = "example",
        });
    
        var exampleEcs = new Harness.Service.Ecs("example", new()
        {
            AppId = example.Id,
            Name = "ecs-example-service",
            Description = "Service for deploying AWS ECS tasks.",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.harness.Application;
    import com.pulumi.harness.ApplicationArgs;
    import com.pulumi.harness.service.Ecs;
    import com.pulumi.harness.service.EcsArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var example = new Application("example", ApplicationArgs.builder()
                .name("example")
                .build());
    
            var exampleEcs = new Ecs("exampleEcs", EcsArgs.builder()
                .appId(example.id())
                .name("ecs-example-service")
                .description("Service for deploying AWS ECS tasks.")
                .build());
    
        }
    }
    
    resources:
      example:
        type: harness:Application
        properties:
          name: example
      exampleEcs:
        type: harness:service:Ecs
        name: example
        properties:
          appId: ${example.id}
          name: ecs-example-service
          description: Service for deploying AWS ECS tasks.
    

    Create Ecs Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Ecs(name: string, args: EcsArgs, opts?: CustomResourceOptions);
    @overload
    def Ecs(resource_name: str,
            args: EcsArgs,
            opts: Optional[ResourceOptions] = None)
    
    @overload
    def Ecs(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            app_id: Optional[str] = None,
            description: Optional[str] = None,
            name: Optional[str] = None,
            variables: Optional[Sequence[EcsVariableArgs]] = None)
    func NewEcs(ctx *Context, name string, args EcsArgs, opts ...ResourceOption) (*Ecs, error)
    public Ecs(string name, EcsArgs args, CustomResourceOptions? opts = null)
    public Ecs(String name, EcsArgs args)
    public Ecs(String name, EcsArgs args, CustomResourceOptions options)
    
    type: harness:service:Ecs
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args EcsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args EcsArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args EcsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EcsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EcsArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var ecsResource = new Harness.Service.Ecs("ecsResource", new()
    {
        AppId = "string",
        Description = "string",
        Name = "string",
        Variables = new[]
        {
            new Harness.Service.Inputs.EcsVariableArgs
            {
                Name = "string",
                Type = "string",
                Value = "string",
            },
        },
    });
    
    example, err := service.NewEcs(ctx, "ecsResource", &service.EcsArgs{
    	AppId:       pulumi.String("string"),
    	Description: pulumi.String("string"),
    	Name:        pulumi.String("string"),
    	Variables: service.EcsVariableArray{
    		&service.EcsVariableArgs{
    			Name:  pulumi.String("string"),
    			Type:  pulumi.String("string"),
    			Value: pulumi.String("string"),
    		},
    	},
    })
    
    var ecsResource = new Ecs("ecsResource", EcsArgs.builder()
        .appId("string")
        .description("string")
        .name("string")
        .variables(EcsVariableArgs.builder()
            .name("string")
            .type("string")
            .value("string")
            .build())
        .build());
    
    ecs_resource = harness.service.Ecs("ecsResource",
        app_id="string",
        description="string",
        name="string",
        variables=[harness.service.EcsVariableArgs(
            name="string",
            type="string",
            value="string",
        )])
    
    const ecsResource = new harness.service.Ecs("ecsResource", {
        appId: "string",
        description: "string",
        name: "string",
        variables: [{
            name: "string",
            type: "string",
            value: "string",
        }],
    });
    
    type: harness:service:Ecs
    properties:
        appId: string
        description: string
        name: string
        variables:
            - name: string
              type: string
              value: string
    

    Ecs Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Ecs resource accepts the following input properties:

    AppId string
    The id of the application the service belongs to
    Description string
    Description of th service
    Name string
    Name of the service
    Variables List<EcsVariable>
    Variables to be used in the service
    AppId string
    The id of the application the service belongs to
    Description string
    Description of th service
    Name string
    Name of the service
    Variables []EcsVariableArgs
    Variables to be used in the service
    appId String
    The id of the application the service belongs to
    description String
    Description of th service
    name String
    Name of the service
    variables List<EcsVariable>
    Variables to be used in the service
    appId string
    The id of the application the service belongs to
    description string
    Description of th service
    name string
    Name of the service
    variables EcsVariable[]
    Variables to be used in the service
    app_id str
    The id of the application the service belongs to
    description str
    Description of th service
    name str
    Name of the service
    variables Sequence[EcsVariableArgs]
    Variables to be used in the service
    appId String
    The id of the application the service belongs to
    description String
    Description of th service
    name String
    Name of the service
    variables List<Property Map>
    Variables to be used in the service

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Ecs resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Ecs Resource

    Get an existing Ecs resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: EcsState, opts?: CustomResourceOptions): Ecs
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            app_id: Optional[str] = None,
            description: Optional[str] = None,
            name: Optional[str] = None,
            variables: Optional[Sequence[EcsVariableArgs]] = None) -> Ecs
    func GetEcs(ctx *Context, name string, id IDInput, state *EcsState, opts ...ResourceOption) (*Ecs, error)
    public static Ecs Get(string name, Input<string> id, EcsState? state, CustomResourceOptions? opts = null)
    public static Ecs get(String name, Output<String> id, EcsState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AppId string
    The id of the application the service belongs to
    Description string
    Description of th service
    Name string
    Name of the service
    Variables List<EcsVariable>
    Variables to be used in the service
    AppId string
    The id of the application the service belongs to
    Description string
    Description of th service
    Name string
    Name of the service
    Variables []EcsVariableArgs
    Variables to be used in the service
    appId String
    The id of the application the service belongs to
    description String
    Description of th service
    name String
    Name of the service
    variables List<EcsVariable>
    Variables to be used in the service
    appId string
    The id of the application the service belongs to
    description string
    Description of th service
    name string
    Name of the service
    variables EcsVariable[]
    Variables to be used in the service
    app_id str
    The id of the application the service belongs to
    description str
    Description of th service
    name str
    Name of the service
    variables Sequence[EcsVariableArgs]
    Variables to be used in the service
    appId String
    The id of the application the service belongs to
    description String
    Description of th service
    name String
    Name of the service
    variables List<Property Map>
    Variables to be used in the service

    Supporting Types

    EcsVariable, EcsVariableArgs

    Name string
    Name of the variable
    Type string
    Type of the variable. Options are 'TEXT' and 'ENCRYPTED_TEXT'
    Value string
    Value of the variable
    Name string
    Name of the variable
    Type string
    Type of the variable. Options are 'TEXT' and 'ENCRYPTED_TEXT'
    Value string
    Value of the variable
    name String
    Name of the variable
    type String
    Type of the variable. Options are 'TEXT' and 'ENCRYPTED_TEXT'
    value String
    Value of the variable
    name string
    Name of the variable
    type string
    Type of the variable. Options are 'TEXT' and 'ENCRYPTED_TEXT'
    value string
    Value of the variable
    name str
    Name of the variable
    type str
    Type of the variable. Options are 'TEXT' and 'ENCRYPTED_TEXT'
    value str
    Value of the variable
    name String
    Name of the variable
    type String
    Type of the variable. Options are 'TEXT' and 'ENCRYPTED_TEXT'
    value String
    Value of the variable

    Import

    Import using the Harness application id and service id

    $ pulumi import harness:service/ecs:Ecs example <app_id>/<svc_id>
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    harness pulumi/pulumi-harness
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the harness Terraform Provider.
    harness logo
    Harness v0.1.1 published on Friday, Jul 12, 2024 by Pulumi