class CfnRepository (construct)

This page is available in another version. Click here for the v2 documentation.

Language	Type name
.NET	`Amazon.CDK.AWS.CodeCommit.CfnRepository`
Java	`software.amazon.awscdk.services.codecommit.CfnRepository`
Python	`aws_cdk.aws_codecommit.CfnRepository`
TypeScript	`@aws-cdk/aws-codecommit` » `CfnRepository`

Implements IConstruct, IConstruct, IDependable, IInspectable

A CloudFormation AWS::CodeCommit::Repository.

Creates a new, empty repository.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as codecommit from '@aws-cdk/aws-codecommit';
const cfnRepository = new codecommit.CfnRepository(this, 'MyCfnRepository', {
  repositoryName: 'repositoryName',

  // the properties below are optional
  code: {
    s3: {
      bucket: 'bucket',
      key: 'key',

      // the properties below are optional
      objectVersion: 'objectVersion',
    },

    // the properties below are optional
    branchName: 'branchName',
  },
  repositoryDescription: 'repositoryDescription',
  tags: [{
    key: 'key',
    value: 'value',
  }],
  triggers: [{
    destinationArn: 'destinationArn',
    events: ['events'],
    name: 'name',

    // the properties below are optional
    branches: ['branches'],
    customData: 'customData',
  }],
});

Initializer

new CfnRepository(scope: Construct, id: string, props: CfnRepositoryProps)

Parameters

scope Construct — - scope in which this resource is defined.
id string — - scoped id of the resource.
props CfnRepositoryProps — - resource properties.

Create a new AWS::CodeCommit::Repository.

Construct Props

Name	Type	Description
repositoryName	`string`	The name of the new repository to be created.
code?	`CodeProperty` `\|` `IResolvable`	Information about code to be committed to a repository after it is created in an AWS CloudFormation stack.
repositoryDescription?	`string`	A comment or description about the new repository.
tags?	`CfnTag[]`	One or more tag key-value pairs to use when tagging this repository.
triggers?	`IResolvable` `\|` `IResolvable` `\|` `RepositoryTriggerProperty[]`	The JSON block of configuration information for each trigger.

repositoryName

Type: string

The name of the new repository to be created.

The repository name must be unique across the calling AWS account . Repository names are limited to 100 alphanumeric, dash, and underscore characters, and cannot include certain characters. For more information about the limits on repository names, see Quotas in the AWS CodeCommit User Guide . The suffix .git is prohibited.

code?

Type: CodeProperty | IResolvable (optional)

Information about code to be committed to a repository after it is created in an AWS CloudFormation stack.

Information about code is only used in resource creation. Updates to a stack will not reflect changes made to code properties after initial resource creation.

You can only use this property to add code when creating a repository with a AWS CloudFormation template at creation time. This property cannot be used for updating code to an existing repository.

repositoryDescription?

Type: string (optional)

A comment or description about the new repository.

The description field for a repository accepts all HTML characters and all valid Unicode characters. Applications that do not HTML-encode the description and display it in a webpage can expose users to potentially malicious code. Make sure that you HTML-encode the description field in any application that uses this API to display the repository description on a webpage.

tags?

Type: CfnTag[] (optional)

One or more tag key-value pairs to use when tagging this repository.

triggers?

Type: IResolvable | IResolvable | RepositoryTriggerProperty[] (optional)

The JSON block of configuration information for each trigger.

Properties

Name	Type	Description
attrArn	`string`	When you pass the logical ID of this resource, the function returns the Amazon Resource Name (ARN) of the repository.
attrCloneUrlHttp	`string`	When you pass the logical ID of this resource, the function returns the URL to use for cloning the repository over HTTPS.
attrCloneUrlSsh	`string`	When you pass the logical ID of this resource, the function returns the URL to use for cloning the repository over SSH.
attrName	`string`	When you pass the logical ID of this resource, the function returns the repository's name.
cfnOptions	`ICfnResourceOptions`	Options for this resource, such as condition, update policy etc.
cfnProperties	`{ [string]: any }`
cfnResourceType	`string`	AWS resource type.
creationStack	`string[]`
logicalId	`string`	The logical ID for this CloudFormation stack element.
node	`ConstructNode`	The construct tree node associated with this construct.
ref	`string`	Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
repositoryName	`string`	The name of the new repository to be created.
stack	`Stack`	The stack in which this element is defined.
tags	`TagManager`	One or more tag key-value pairs to use when tagging this repository.
code?	`CodeProperty` `\|` `IResolvable`	Information about code to be committed to a repository after it is created in an AWS CloudFormation stack.
repositoryDescription?	`string`	A comment or description about the new repository.
triggers?	`IResolvable` `\|` `IResolvable` `\|` `RepositoryTriggerProperty[]`	The JSON block of configuration information for each trigger.
static CFN_RESOURCE_TYPE_NAME	`string`	The CloudFormation resource type name for this resource class.

attrArn

Type: string

When you pass the logical ID of this resource, the function returns the Amazon Resource Name (ARN) of the repository.

attrCloneUrlHttp

Type: string

When you pass the logical ID of this resource, the function returns the URL to use for cloning the repository over HTTPS.

attrCloneUrlSsh

Type: string

When you pass the logical ID of this resource, the function returns the URL to use for cloning the repository over SSH.

attrName

Type: string

When you pass the logical ID of this resource, the function returns the repository's name.

cfnOptions

Type: ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

cfnProperties

Type: { [string]: any }

cfnResourceType

Type: string

AWS resource type.

creationStack

Type: string[]

logicalId

Type: string

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

node

Type: ConstructNode

The construct tree node associated with this construct.

ref

Type: string

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

repositoryName

Type: string

The name of the new repository to be created.

The repository name must be unique across the calling AWS account . Repository names are limited to 100 alphanumeric, dash, and underscore characters, and cannot include certain characters. For more information about the limits on repository names, see Quotas in the AWS CodeCommit User Guide . The suffix .git is prohibited.

stack

Type: Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

code?

Type: CodeProperty | IResolvable (optional)

Information about code to be committed to a repository after it is created in an AWS CloudFormation stack.

Information about code is only used in resource creation. Updates to a stack will not reflect changes made to code properties after initial resource creation.

You can only use this property to add code when creating a repository with a AWS CloudFormation template at creation time. This property cannot be used for updating code to an existing repository.

repositoryDescription?

Type: string (optional)

A comment or description about the new repository.

The description field for a repository accepts all HTML characters and all valid Unicode characters. Applications that do not HTML-encode the description and display it in a webpage can expose users to potentially malicious code. Make sure that you HTML-encode the description field in any application that uses this API to display the repository description on a webpage.

triggers?

Type: IResolvable | IResolvable | RepositoryTriggerProperty[] (optional)

The JSON block of configuration information for each trigger.

static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

Name	Description
addDeletionOverride(path)	Syntactic sugar for `addOverride(path, undefined)`.
addDependsOn(target)	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)	Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)	Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)	Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)	Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)	Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName)	Returns a token for an runtime attribute of this resource.
getMetadata(key)	Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)	Examines the CloudFormation resource and discloses attributes.
overrideLogicalId(newLogicalId)	Overrides the auto-generated logical ID with a specific ID.
toString()	Returns a string representation of this construct.
protected renderProperties(props)

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).

addDependsOn(target)

public addDependsOn(target: CfnResource): void

Parameters

target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

key string
value any

Add a value to the CloudFormation Resource Metadata.

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

addOverride(path, value)

public addOverride(path: string, value: any): void

Parameters

path string — - The path of the property, you can use dot notation to override values in complex types.
value any — - The value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

addPropertyDeletionOverride(propertyPath)

public addPropertyDeletionOverride(propertyPath: string): void

Parameters

propertyPath string — The path to the property.

Adds an override that deletes the value of a property from the resource definition.

addPropertyOverride(propertyPath, value)

public addPropertyOverride(propertyPath: string, value: any): void

Parameters

propertyPath string — The path of the property.
value any — The value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

policy RemovalPolicy
options RemovalPolicyOptions

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

getAtt(attributeName)

public getAtt(attributeName: string): Reference

Parameters

attributeName string — The name of the attribute.

Returns

Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

getMetadata(key)

public getMetadata(key: string): any

Parameters

key string

Returns

any

Retrieve a value value from the CloudFormation Resource Metadata.

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

inspect(inspector)

public inspect(inspector: TreeInspector): void

Parameters

inspector TreeInspector — - tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.

overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

newLogicalId string — The new logical ID to use for this stack element.

Overrides the auto-generated logical ID with a specific ID.

toString()

public toString(): string

Returns

string

Returns a string representation of this construct.

protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

props { [string]: any }

Returns

{ [string]: any }