1. Docs
  2. Reference
  3. API
  4. @pulumi/aws
  5. codecommit

Module codecommit

This page documents the language specification for the aws package. If you're looking for help working with the inputs, outputs, or functions of aws resources in a Pulumi program, please see the resource documentation for examples and API reference.

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-aws repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-aws repo.

Resources

Functions

Others

Resources

Resource Repository

class Repository extends CustomResource

Provides a CodeCommit Repository Resource.

Example Usage

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

const test = new aws.codecommit.Repository("test", {
    description: "This is the Sample App Repository",
    repositoryName: "MyTestRepository",
});

constructor

new Repository(name: string, args: RepositoryArgs, opts?: pulumi.CustomResourceOptions)

Create a Repository resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: RepositoryState, opts?: pulumi.CustomResourceOptions): Repository

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Repository

Returns true if the given object is an instance of Repository. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property arn

public arn: pulumi.Output<string>;

The ARN of the repository

property cloneUrlHttp

public cloneUrlHttp: pulumi.Output<string>;

The URL to use for cloning the repository over HTTPS.

property cloneUrlSsh

public cloneUrlSsh: pulumi.Output<string>;

The URL to use for cloning the repository over SSH.

property defaultBranch

public defaultBranch: pulumi.Output<string | undefined>;

The default branch of the repository. The branch specified here needs to exist.

property description

public description: pulumi.Output<string | undefined>;

The description of the repository. This needs to be less than 1000 characters

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property repositoryId

public repositoryId: pulumi.Output<string>;

The ID of the repository

property repositoryName

public repositoryName: pulumi.Output<string>;

The name for the repository. This needs to be less than 100 characters.

property tags

public tags: pulumi.Output<{[key: string]: any} | undefined>;

Key-value map of resource tags

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource Trigger

class Trigger extends CustomResource

Provides a CodeCommit Trigger Resource.

Example Usage

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

const testRepository = new aws.codecommit.Repository("test", {
    repositoryName: "test",
});
const testTrigger = new aws.codecommit.Trigger("test", {
    repositoryName: testRepository.repositoryName,
    triggers: [{
        destinationArn: aws_sns_topic_test.arn,
        events: ["all"],
        name: "all",
    }],
});

constructor

new Trigger(name: string, args: TriggerArgs, opts?: pulumi.CustomResourceOptions)

Create a Trigger resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: TriggerState, opts?: pulumi.CustomResourceOptions): Trigger

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Trigger

Returns true if the given object is an instance of Trigger. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property configurationId

public configurationId: pulumi.Output<string>;

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property repositoryName

public repositoryName: pulumi.Output<string>;

The name for the repository. This needs to be less than 100 characters.

property triggers

public triggers: pulumi.Output<TriggerTrigger[]>;

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Functions

Function getRepository

getRepository(args: GetRepositoryArgs, opts?: pulumi.InvokeOptions): Promise<GetRepositoryResult>

The CodeCommit Repository data source allows the ARN, Repository ID, Repository URL for HTTP and Repository URL for SSH to be retrieved for an CodeCommit repository.

Example Usage

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

const test = pulumi.output(aws.codecommit.getRepository({
    repositoryName: "MyTestRepository",
}, { async: true }));

Others

interface GetRepositoryArgs

interface GetRepositoryArgs

A collection of arguments for invoking getRepository.

property repositoryName

repositoryName: string;

The name for the repository. This needs to be less than 100 characters.

interface GetRepositoryResult

interface GetRepositoryResult

A collection of values returned by getRepository.

property arn

arn: string;

The ARN of the repository

property cloneUrlHttp

cloneUrlHttp: string;

The URL to use for cloning the repository over HTTPS.

property cloneUrlSsh

cloneUrlSsh: string;

The URL to use for cloning the repository over SSH.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property repositoryId

repositoryId: string;

The ID of the repository

property repositoryName

repositoryName: string;

interface RepositoryArgs

interface RepositoryArgs

The set of arguments for constructing a Repository resource.

property defaultBranch

defaultBranch?: pulumi.Input<string>;

The default branch of the repository. The branch specified here needs to exist.

property description

description?: pulumi.Input<string>;

The description of the repository. This needs to be less than 1000 characters

property repositoryName

repositoryName: pulumi.Input<string>;

The name for the repository. This needs to be less than 100 characters.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

Key-value map of resource tags

interface RepositoryState

interface RepositoryState

Input properties used for looking up and filtering Repository resources.

property arn

arn?: pulumi.Input<string>;

The ARN of the repository

property cloneUrlHttp

cloneUrlHttp?: pulumi.Input<string>;

The URL to use for cloning the repository over HTTPS.

property cloneUrlSsh

cloneUrlSsh?: pulumi.Input<string>;

The URL to use for cloning the repository over SSH.

property defaultBranch

defaultBranch?: pulumi.Input<string>;

The default branch of the repository. The branch specified here needs to exist.

property description

description?: pulumi.Input<string>;

The description of the repository. This needs to be less than 1000 characters

property repositoryId

repositoryId?: pulumi.Input<string>;

The ID of the repository

property repositoryName

repositoryName?: pulumi.Input<string>;

The name for the repository. This needs to be less than 100 characters.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

Key-value map of resource tags

interface TriggerArgs

interface TriggerArgs

The set of arguments for constructing a Trigger resource.

property repositoryName

repositoryName: pulumi.Input<string>;

The name for the repository. This needs to be less than 100 characters.

property triggers

triggers: pulumi.Input<pulumi.Input<TriggerTrigger>[]>;

interface TriggerState

interface TriggerState

Input properties used for looking up and filtering Trigger resources.

property configurationId

configurationId?: pulumi.Input<string>;

property repositoryName

repositoryName?: pulumi.Input<string>;

The name for the repository. This needs to be less than 100 characters.

property triggers

triggers?: pulumi.Input<pulumi.Input<TriggerTrigger>[]>;