Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. codecatalyst
  5. Project
AWS v6.54.0 published on Friday, Sep 27, 2024 by Pulumi
pulumi/pulumi-aws

aws.codecatalyst.Project

Explore with Pulumi AI

aws logo
AWS v6.54.0 published on Friday, Sep 27, 2024 by Pulumi
pulumi/pulumi-aws

    Resource for managing an AWS CodeCatalyst Project.

    Example Usage

    Basic Usage

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const test = new aws.codecatalyst.Project("test", {
    spaceName: "myproject",
    displayName: "MyProject",
    description: "My CodeCatalyst Project created using Pulumi",
});

    import pulumi
import pulumi_aws as aws

test = aws.codecatalyst.Project("test",
    space_name="myproject",
    display_name="MyProject",
    description="My CodeCatalyst Project created using Pulumi")

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/codecatalyst"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := codecatalyst.NewProject(ctx, "test", &codecatalyst.ProjectArgs{
			SpaceName:   pulumi.String("myproject"),
			DisplayName: pulumi.String("MyProject"),
			Description: pulumi.String("My CodeCatalyst Project created using Pulumi"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var test = new Aws.CodeCatalyst.Project("test", new()
    {
        SpaceName = "myproject",
        DisplayName = "MyProject",
        Description = "My CodeCatalyst Project created using Pulumi",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.codecatalyst.Project;
import com.pulumi.aws.codecatalyst.ProjectArgs;
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 test = new Project("test", ProjectArgs.builder()
            .spaceName("myproject")
            .displayName("MyProject")
            .description("My CodeCatalyst Project created using Pulumi")
            .build());

    }
}

    resources:
  test:
    type: aws:codecatalyst:Project
    properties:
      spaceName: myproject
      displayName: MyProject
      description: My CodeCatalyst Project created using Pulumi

    Create Project Resource

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

    Constructor syntax

    new Project(name: string, args: ProjectArgs, opts?: CustomResourceOptions);
    @overload
def Project(resource_name: str,
            args: ProjectArgs,
            opts: Optional[ResourceOptions] = None)

@overload
def Project(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            display_name: Optional[str] = None,
            space_name: Optional[str] = None,
            description: Optional[str] = None)
    func NewProject(ctx *Context, name string, args ProjectArgs, opts ...ResourceOption) (*Project, error)
    public Project(string name, ProjectArgs args, CustomResourceOptions? opts = null)
    public Project(String name, ProjectArgs args)
public Project(String name, ProjectArgs args, CustomResourceOptions options)

    type: aws:codecatalyst:Project
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 ProjectArgs
    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 ProjectArgs
    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 ProjectArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ProjectArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ProjectArgs
    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 awsProjectResource = new Aws.CodeCatalyst.Project("awsProjectResource", new()
{
    DisplayName = "string",
    SpaceName = "string",
    Description = "string",
});

    example, err := codecatalyst.NewProject(ctx, "awsProjectResource", &codecatalyst.ProjectArgs{
	DisplayName: pulumi.String("string"),
	SpaceName:   pulumi.String("string"),
	Description: pulumi.String("string"),
})

    var awsProjectResource = new Project("awsProjectResource", ProjectArgs.builder()
    .displayName("string")
    .spaceName("string")
    .description("string")
    .build());

    aws_project_resource = aws.codecatalyst.Project("awsProjectResource",
    display_name="string",
    space_name="string",
    description="string")

    const awsProjectResource = new aws.codecatalyst.Project("awsProjectResource", {
    displayName: "string",
    spaceName: "string",
    description: "string",
});

    type: aws:codecatalyst:Project
properties:
    description: string
    displayName: string
    spaceName: string

    Project 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 Project resource accepts the following input properties:

    DisplayName string

    The friendly name of the project that will be displayed to users.

    The following arguments are optional:

    SpaceName string
    The name of the space.
    Description string
    The description of the project. This description will be displayed to all users of the project. We recommend providing a brief description of the project and its intended purpose.
    DisplayName string

    The friendly name of the project that will be displayed to users.

    The following arguments are optional:

    SpaceName string
    The name of the space.
    Description string
    The description of the project. This description will be displayed to all users of the project. We recommend providing a brief description of the project and its intended purpose.
    displayName String

    The friendly name of the project that will be displayed to users.

    The following arguments are optional:

    spaceName String
    The name of the space.
    description String
    The description of the project. This description will be displayed to all users of the project. We recommend providing a brief description of the project and its intended purpose.
    displayName string

    The friendly name of the project that will be displayed to users.

    The following arguments are optional:

    spaceName string
    The name of the space.
    description string
    The description of the project. This description will be displayed to all users of the project. We recommend providing a brief description of the project and its intended purpose.
    display_name str

    The friendly name of the project that will be displayed to users.

    The following arguments are optional:

    space_name str
    The name of the space.
    description str
    The description of the project. This description will be displayed to all users of the project. We recommend providing a brief description of the project and its intended purpose.
    displayName String

    The friendly name of the project that will be displayed to users.

    The following arguments are optional:

    spaceName String
    The name of the space.
    description String
    The description of the project. This description will be displayed to all users of the project. We recommend providing a brief description of the project and its intended purpose.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the project in the space.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the project in the space.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the project in the space.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The name of the project in the space.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The name of the project in the space.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the project in the space.

    Look up Existing Project Resource

    Get an existing Project 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?: ProjectState, opts?: CustomResourceOptions): Project
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        name: Optional[str] = None,
        space_name: Optional[str] = None) -> Project
    func GetProject(ctx *Context, name string, id IDInput, state *ProjectState, opts ...ResourceOption) (*Project, error)
    public static Project Get(string name, Input<string> id, ProjectState? state, CustomResourceOptions? opts = null)
    public static Project get(String name, Output<String> id, ProjectState 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:
    Description string
    The description of the project. This description will be displayed to all users of the project. We recommend providing a brief description of the project and its intended purpose.
    DisplayName string

    The friendly name of the project that will be displayed to users.

    The following arguments are optional:

    Name string
    The name of the project in the space.
    SpaceName string
    The name of the space.
    Description string
    The description of the project. This description will be displayed to all users of the project. We recommend providing a brief description of the project and its intended purpose.
    DisplayName string

    The friendly name of the project that will be displayed to users.

    The following arguments are optional:

    Name string
    The name of the project in the space.
    SpaceName string
    The name of the space.
    description String
    The description of the project. This description will be displayed to all users of the project. We recommend providing a brief description of the project and its intended purpose.
    displayName String

    The friendly name of the project that will be displayed to users.

    The following arguments are optional:

    name String
    The name of the project in the space.
    spaceName String
    The name of the space.
    description string
    The description of the project. This description will be displayed to all users of the project. We recommend providing a brief description of the project and its intended purpose.
    displayName string

    The friendly name of the project that will be displayed to users.

    The following arguments are optional:

    name string
    The name of the project in the space.
    spaceName string
    The name of the space.
    description str
    The description of the project. This description will be displayed to all users of the project. We recommend providing a brief description of the project and its intended purpose.
    display_name str

    The friendly name of the project that will be displayed to users.

    The following arguments are optional:

    name str
    The name of the project in the space.
    space_name str
    The name of the space.
    description String
    The description of the project. This description will be displayed to all users of the project. We recommend providing a brief description of the project and its intended purpose.
    displayName String

    The friendly name of the project that will be displayed to users.

    The following arguments are optional:

    name String
    The name of the project in the space.
    spaceName String
    The name of the space.

    Import

    Using pulumi import, import CodeCatalyst Project using the id. For example:

    $ pulumi import aws:codecatalyst/project:Project example project-id-12345678

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

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.54.0 published on Friday, Sep 27, 2024 by Pulumi
    pulumi/pulumi-aws