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

aws.codecatalyst.SourceRepository

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 Source Repository.

    Example Usage

    Basic Usage

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

const example = new aws.codecatalyst.SourceRepository("example", {
    name: "example-repo",
    projectName: "example-project",
    spaceName: "example-space",
});

    import pulumi
import pulumi_aws as aws

example = aws.codecatalyst.SourceRepository("example",
    name="example-repo",
    project_name="example-project",
    space_name="example-space")

    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.NewSourceRepository(ctx, "example", &codecatalyst.SourceRepositoryArgs{
			Name:        pulumi.String("example-repo"),
			ProjectName: pulumi.String("example-project"),
			SpaceName:   pulumi.String("example-space"),
		})
		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 example = new Aws.CodeCatalyst.SourceRepository("example", new()
    {
        Name = "example-repo",
        ProjectName = "example-project",
        SpaceName = "example-space",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.codecatalyst.SourceRepository;
import com.pulumi.aws.codecatalyst.SourceRepositoryArgs;
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 SourceRepository("example", SourceRepositoryArgs.builder()
            .name("example-repo")
            .projectName("example-project")
            .spaceName("example-space")
            .build());

    }
}

    resources:
  example:
    type: aws:codecatalyst:SourceRepository
    properties:
      name: example-repo
      projectName: example-project
      spaceName: example-space

    Create SourceRepository Resource

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

    Constructor syntax

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

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

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

    example, err := codecatalyst.NewSourceRepository(ctx, "sourceRepositoryResource", &codecatalyst.SourceRepositoryArgs{
	ProjectName: pulumi.String("string"),
	SpaceName:   pulumi.String("string"),
	Description: pulumi.String("string"),
	Name:        pulumi.String("string"),
})

    var sourceRepositoryResource = new SourceRepository("sourceRepositoryResource", SourceRepositoryArgs.builder()
    .projectName("string")
    .spaceName("string")
    .description("string")
    .name("string")
    .build());

    source_repository_resource = aws.codecatalyst.SourceRepository("sourceRepositoryResource",
    project_name="string",
    space_name="string",
    description="string",
    name="string")

    const sourceRepositoryResource = new aws.codecatalyst.SourceRepository("sourceRepositoryResource", {
    projectName: "string",
    spaceName: "string",
    description: "string",
    name: "string",
});

    type: aws:codecatalyst:SourceRepository
properties:
    description: string
    name: string
    projectName: string
    spaceName: string

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

    ProjectName string

    The name of the project in the CodeCatalyst space.

    The following arguments are optional:

    SpaceName string
    The name of the CodeCatalyst 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.
    Name string
    The name of the source repository. For more information about name requirements, see Quotas for source repositories.
    ProjectName string

    The name of the project in the CodeCatalyst space.

    The following arguments are optional:

    SpaceName string
    The name of the CodeCatalyst 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.
    Name string
    The name of the source repository. For more information about name requirements, see Quotas for source repositories.
    projectName String

    The name of the project in the CodeCatalyst space.

    The following arguments are optional:

    spaceName String
    The name of the CodeCatalyst 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.
    name String
    The name of the source repository. For more information about name requirements, see Quotas for source repositories.
    projectName string

    The name of the project in the CodeCatalyst space.

    The following arguments are optional:

    spaceName string
    The name of the CodeCatalyst 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.
    name string
    The name of the source repository. For more information about name requirements, see Quotas for source repositories.
    project_name str

    The name of the project in the CodeCatalyst space.

    The following arguments are optional:

    space_name str
    The name of the CodeCatalyst 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.
    name str
    The name of the source repository. For more information about name requirements, see Quotas for source repositories.
    projectName String

    The name of the project in the CodeCatalyst space.

    The following arguments are optional:

    spaceName String
    The name of the CodeCatalyst 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.
    name String
    The name of the source repository. For more information about name requirements, see Quotas for source repositories.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the SourceRepository 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 SourceRepository Resource

    Get an existing SourceRepository 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?: SourceRepositoryState, opts?: CustomResourceOptions): SourceRepository
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        name: Optional[str] = None,
        project_name: Optional[str] = None,
        space_name: Optional[str] = None) -> SourceRepository
    func GetSourceRepository(ctx *Context, name string, id IDInput, state *SourceRepositoryState, opts ...ResourceOption) (*SourceRepository, error)
    public static SourceRepository Get(string name, Input<string> id, SourceRepositoryState? state, CustomResourceOptions? opts = null)
    public static SourceRepository get(String name, Output<String> id, SourceRepositoryState 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.
    Name string
    The name of the source repository. For more information about name requirements, see Quotas for source repositories.
    ProjectName string

    The name of the project in the CodeCatalyst space.

    The following arguments are optional:

    SpaceName string
    The name of the CodeCatalyst 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.
    Name string
    The name of the source repository. For more information about name requirements, see Quotas for source repositories.
    ProjectName string

    The name of the project in the CodeCatalyst space.

    The following arguments are optional:

    SpaceName string
    The name of the CodeCatalyst 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.
    name String
    The name of the source repository. For more information about name requirements, see Quotas for source repositories.
    projectName String

    The name of the project in the CodeCatalyst space.

    The following arguments are optional:

    spaceName String
    The name of the CodeCatalyst 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.
    name string
    The name of the source repository. For more information about name requirements, see Quotas for source repositories.
    projectName string

    The name of the project in the CodeCatalyst space.

    The following arguments are optional:

    spaceName string
    The name of the CodeCatalyst 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.
    name str
    The name of the source repository. For more information about name requirements, see Quotas for source repositories.
    project_name str

    The name of the project in the CodeCatalyst space.

    The following arguments are optional:

    space_name str
    The name of the CodeCatalyst 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.
    name String
    The name of the source repository. For more information about name requirements, see Quotas for source repositories.
    projectName String

    The name of the project in the CodeCatalyst space.

    The following arguments are optional:

    spaceName String
    The name of the CodeCatalyst space.

    Import

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

    $ pulumi import aws:codecatalyst/sourceRepository:SourceRepository example example-repo

    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