Skip to content

Latest commit

 

History

History
1739 lines (1031 loc) · 71.9 KB

API.md

File metadata and controls

1739 lines (1031 loc) · 71.9 KB
Raw

Commitizen friendly npm

View on Construct Hub

AWS CodeStar Connection Construct Library

This package contains constructs for working with Amazon CodeStar Connection.

CodeStar Connection

Define a Codestar Connection by creating a new instance of CodeStarConnection. You can create a connection for different providers

const codestartConnection = new CodeStarConnection(
  this,
  'CodeStarConnection',
    {
      connectionName: 'github-connection',
      providerType: CodeStarConnectionProviderType.GITHUB,
    }
  );

API Reference

Constructs

CodeStarConnection

Define a CodeStar Connection resource.

Example

  new CodeStarConnection(this, 'MyConnection', {
    connectionName: 'MyConnection',
    providerType: 'GitHub',
    tags: [{
      key: 'key',
      value: 'value',
    }],
  }

Initializers 

import { CodeStarConnection } from '@jttc/aws-codestarconnection'

new CodeStarConnection(scope: Construct, id: string, props: CodeStarConnectionProps)
Name Type Description
scope constructs.Construct No description.
id string No description.
props CodeStarConnectionProps No description.
scopeRequired
  • Type: constructs.Construct
idRequired
  • Type: string
propsRequired

Methods

Name Description
toString Returns a string representation of this construct.
applyRemovalPolicy Apply the given removal policy to this resource.
grant Grant the given principal identity permissions to perform the actions on this code star connection.
grantAdmin you want to grant an IAM user in your AWS account full access to AWS CodeStar Connections, so that the user can add, update, and delete connections.
grantConnectionFullAccess Grant the given identity permission to full access to the code star connection.
grantRead you want to grant an IAM user in your account read-only access to the connections in your AWS account.
grantUse Grant the given identity permissions to use this code star connetion.
validateConnectionName Validate if the name of the code connection is longer thatn 32 characters.
toString 
public toString(): string

Returns a string representation of this construct.

applyRemovalPolicy 
public applyRemovalPolicy(policy: RemovalPolicy): void

Apply the given removal policy to this resource.

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).

policyRequired
  • Type: aws-cdk-lib.RemovalPolicy
grant 
public grant(grantee: IGrantable, actions: string): Grant

Grant the given principal identity permissions to perform the actions on this code star connection.

granteeRequired
  • Type: aws-cdk-lib.aws_iam.IGrantable
actionsRequired
  • Type: string
grantAdmin 
public grantAdmin(grantee: IGrantable): Grant

you want to grant an IAM user in your AWS account full access to AWS CodeStar Connections, so that the user can add, update, and delete connections.

https://docs.aws.amazon.com/dtconsole/latest/userguide/security_iam_id-based-policy-examples-connections.html#security_iam_id-based-policy-examples-connections-fullaccess

granteeRequired
  • Type: aws-cdk-lib.aws_iam.IGrantable
grantConnectionFullAccess 
public grantConnectionFullAccess(grantee: IGrantable): Grant

Grant the given identity permission to full access to the code star connection.

https://docs.aws.amazon.com/dtconsole/latest/userguide/security_iam_id-based-policy-examples-connections.html#security_iam_id-based-policy-examples-connections-clisdk

granteeRequired
  • Type: aws-cdk-lib.aws_iam.IGrantable
grantRead 
public grantRead(grantee: IGrantable): Grant

you want to grant an IAM user in your account read-only access to the connections in your AWS account.

https://docs.aws.amazon.com/dtconsole/latest/userguide/security_iam_id-based-policy-examples-connections.html#security_iam_id-based-policy-examples-connections-readonly

granteeRequired
  • Type: aws-cdk-lib.aws_iam.IGrantable
grantUse 
public grantUse(grantee: IGrantable): Grant

Grant the given identity permissions to use this code star connetion.

granteeRequired
  • Type: aws-cdk-lib.aws_iam.IGrantable
validateConnectionName 
public validateConnectionName(name: string): void

Validate if the name of the code connection is longer thatn 32 characters.

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarconnections-connection.html#cfn-codestarconnections-connection-connectionname

nameRequired
  • Type: string

Name of the connection.

Static Functions

Name Description
isConstruct Checks if x is a construct.
isOwnedResource Returns true if the construct was created by CDK, and false otherwise.
isResource Check whether the given construct is a Resource.
fromCodeStarConnectionArn Import an externally defined Code Star Connection using its ARN.
isConstruct 
import { CodeStarConnection } from '@jttc/aws-codestarconnection'

CodeStarConnection.isConstruct(x: any)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

xRequired
  • Type: any

Any object.

isOwnedResource 
import { CodeStarConnection } from '@jttc/aws-codestarconnection'

CodeStarConnection.isOwnedResource(construct: IConstruct)

Returns true if the construct was created by CDK, and false otherwise.

constructRequired
  • Type: constructs.IConstruct
isResource 
import { CodeStarConnection } from '@jttc/aws-codestarconnection'

CodeStarConnection.isResource(construct: IConstruct)

Check whether the given construct is a Resource.

constructRequired
  • Type: constructs.IConstruct
fromCodeStarConnectionArn 
import { CodeStarConnection } from '@jttc/aws-codestarconnection'

CodeStarConnection.fromCodeStarConnectionArn(scope: Construct, id: string, codestarConnectionArn: string)

Import an externally defined Code Star Connection using its ARN.

scopeRequired
  • Type: constructs.Construct

the construct that will "own" the imported key.

idRequired
  • Type: string

the id of the imported code star conection in the construct tree.

codestarConnectionArnRequired
  • Type: string

the ARN of an existing Code Star Connection.

Properties

Name Type Description
node constructs.Node The tree node.
env aws-cdk-lib.ResourceEnvironment The environment this resource belongs to.
stack aws-cdk-lib.Stack The stack in which this resource is defined.
connectionArn string The ARN of the Code Star connection.
connectionName string The name of the Code Star connection.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

envRequired 
public readonly env: ResourceEnvironment;
  • Type: aws-cdk-lib.ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

stackRequired 
public readonly stack: Stack;
  • Type: aws-cdk-lib.Stack

The stack in which this resource is defined.

connectionArnRequired 
public readonly connectionArn: string;
  • Type: string

The ARN of the Code Star connection.

connectionNameRequired 
public readonly connectionName: string;
  • Type: string

The name of the Code Star connection.

CodeStarConnectionBase

Initializers 

import { CodeStarConnectionBase } from '@jttc/aws-codestarconnection'

new CodeStarConnectionBase(scope: Construct, id: string, props?: ResourceProps)
Name Type Description
scope constructs.Construct No description.
id string No description.
props aws-cdk-lib.ResourceProps No description.
scopeRequired
  • Type: constructs.Construct
idRequired
  • Type: string
propsOptional
  • Type: aws-cdk-lib.ResourceProps

Methods

Name Description
toString Returns a string representation of this construct.
applyRemovalPolicy Apply the given removal policy to this resource.
grant Grant the given principal identity permissions to perform the actions on this code star connection.
grantAdmin you want to grant an IAM user in your AWS account full access to AWS CodeStar Connections, so that the user can add, update, and delete connections.
grantConnectionFullAccess Grant the given identity permission to full access to the code star connection.
grantRead you want to grant an IAM user in your account read-only access to the connections in your AWS account.
grantUse Grant the given identity permissions to use this code star connetion.
validateConnectionName Validate if the name of the code connection is longer thatn 32 characters.
toString 
public toString(): string

Returns a string representation of this construct.

applyRemovalPolicy 
public applyRemovalPolicy(policy: RemovalPolicy): void

Apply the given removal policy to this resource.

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).

policyRequired
  • Type: aws-cdk-lib.RemovalPolicy
grant 
public grant(grantee: IGrantable, actions: string): Grant

Grant the given principal identity permissions to perform the actions on this code star connection.

granteeRequired
  • Type: aws-cdk-lib.aws_iam.IGrantable
actionsRequired
  • Type: string
grantAdmin 
public grantAdmin(grantee: IGrantable): Grant

you want to grant an IAM user in your AWS account full access to AWS CodeStar Connections, so that the user can add, update, and delete connections.

https://docs.aws.amazon.com/dtconsole/latest/userguide/security_iam_id-based-policy-examples-connections.html#security_iam_id-based-policy-examples-connections-fullaccess

granteeRequired
  • Type: aws-cdk-lib.aws_iam.IGrantable
grantConnectionFullAccess 
public grantConnectionFullAccess(grantee: IGrantable): Grant

Grant the given identity permission to full access to the code star connection.

https://docs.aws.amazon.com/dtconsole/latest/userguide/security_iam_id-based-policy-examples-connections.html#security_iam_id-based-policy-examples-connections-clisdk

granteeRequired
  • Type: aws-cdk-lib.aws_iam.IGrantable
grantRead 
public grantRead(grantee: IGrantable): Grant

you want to grant an IAM user in your account read-only access to the connections in your AWS account.

https://docs.aws.amazon.com/dtconsole/latest/userguide/security_iam_id-based-policy-examples-connections.html#security_iam_id-based-policy-examples-connections-readonly

granteeRequired
  • Type: aws-cdk-lib.aws_iam.IGrantable
grantUse 
public grantUse(grantee: IGrantable): Grant

Grant the given identity permissions to use this code star connetion.

granteeRequired
  • Type: aws-cdk-lib.aws_iam.IGrantable
validateConnectionName 
public validateConnectionName(name: string): void

Validate if the name of the code connection is longer thatn 32 characters.

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarconnections-connection.html#cfn-codestarconnections-connection-connectionname

nameRequired
  • Type: string

Name of the connection.

Static Functions

Name Description
isConstruct Checks if x is a construct.
isOwnedResource Returns true if the construct was created by CDK, and false otherwise.
isResource Check whether the given construct is a Resource.
isConstruct 
import { CodeStarConnectionBase } from '@jttc/aws-codestarconnection'

CodeStarConnectionBase.isConstruct(x: any)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

xRequired
  • Type: any

Any object.

isOwnedResource 
import { CodeStarConnectionBase } from '@jttc/aws-codestarconnection'

CodeStarConnectionBase.isOwnedResource(construct: IConstruct)

Returns true if the construct was created by CDK, and false otherwise.

constructRequired
  • Type: constructs.IConstruct
isResource 
import { CodeStarConnectionBase } from '@jttc/aws-codestarconnection'

CodeStarConnectionBase.isResource(construct: IConstruct)

Check whether the given construct is a Resource.

constructRequired
  • Type: constructs.IConstruct

Properties

Name Type Description
node constructs.Node The tree node.
env aws-cdk-lib.ResourceEnvironment The environment this resource belongs to.
stack aws-cdk-lib.Stack The stack in which this resource is defined.
connectionArn string The ARN of the Code Star connection.
connectionName string The name of the Code Star connection.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

envRequired 
public readonly env: ResourceEnvironment;
  • Type: aws-cdk-lib.ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

stackRequired 
public readonly stack: Stack;
  • Type: aws-cdk-lib.Stack

The stack in which this resource is defined.

connectionArnRequired 
public readonly connectionArn: string;
  • Type: string

The ARN of the Code Star connection.

connectionNameRequired 
public readonly connectionName: string;
  • Type: string

The name of the Code Star connection.

GithubCodeStarConnection

Define a Github CodeStar Connection resource.

Example

  new GithubCodeStarConnection(this, 'GithubConnection')

Initializers 

import { GithubCodeStarConnection } from '@jttc/aws-codestarconnection'

new GithubCodeStarConnection(scope: Construct, id: string, props?: GithubCodeStarConnetionProps)
Name Type Description
scope constructs.Construct No description.
id string No description.
props GithubCodeStarConnetionProps No description.
scopeRequired
  • Type: constructs.Construct
idRequired
  • Type: string
propsOptional

Methods

Name Description
toString Returns a string representation of this construct.
applyRemovalPolicy Apply the given removal policy to this resource.
grant Grant the given principal identity permissions to perform the actions on this code star connection.
grantAdmin you want to grant an IAM user in your AWS account full access to AWS CodeStar Connections, so that the user can add, update, and delete connections.
grantConnectionFullAccess Grant the given identity permission to full access to the code star connection.
grantRead you want to grant an IAM user in your account read-only access to the connections in your AWS account.
grantUse Grant the given identity permissions to use this code star connetion.
validateConnectionName Validate if the name of the code connection is longer thatn 32 characters.
toString 
public toString(): string

Returns a string representation of this construct.

applyRemovalPolicy 
public applyRemovalPolicy(policy: RemovalPolicy): void

Apply the given removal policy to this resource.

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).

policyRequired
  • Type: aws-cdk-lib.RemovalPolicy
grant 
public grant(grantee: IGrantable, actions: string): Grant

Grant the given principal identity permissions to perform the actions on this code star connection.

granteeRequired
  • Type: aws-cdk-lib.aws_iam.IGrantable
actionsRequired
  • Type: string
grantAdmin 
public grantAdmin(grantee: IGrantable): Grant

you want to grant an IAM user in your AWS account full access to AWS CodeStar Connections, so that the user can add, update, and delete connections.

https://docs.aws.amazon.com/dtconsole/latest/userguide/security_iam_id-based-policy-examples-connections.html#security_iam_id-based-policy-examples-connections-fullaccess

granteeRequired
  • Type: aws-cdk-lib.aws_iam.IGrantable
grantConnectionFullAccess 
public grantConnectionFullAccess(grantee: IGrantable): Grant

Grant the given identity permission to full access to the code star connection.

https://docs.aws.amazon.com/dtconsole/latest/userguide/security_iam_id-based-policy-examples-connections.html#security_iam_id-based-policy-examples-connections-clisdk

granteeRequired
  • Type: aws-cdk-lib.aws_iam.IGrantable
grantRead 
public grantRead(grantee: IGrantable): Grant

you want to grant an IAM user in your account read-only access to the connections in your AWS account.

https://docs.aws.amazon.com/dtconsole/latest/userguide/security_iam_id-based-policy-examples-connections.html#security_iam_id-based-policy-examples-connections-readonly

granteeRequired
  • Type: aws-cdk-lib.aws_iam.IGrantable
grantUse 
public grantUse(grantee: IGrantable): Grant

Grant the given identity permissions to use this code star connetion.

granteeRequired
  • Type: aws-cdk-lib.aws_iam.IGrantable
validateConnectionName 
public validateConnectionName(name: string): void

Validate if the name of the code connection is longer thatn 32 characters.

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarconnections-connection.html#cfn-codestarconnections-connection-connectionname

nameRequired
  • Type: string

Name of the connection.

Static Functions

Name Description
isConstruct Checks if x is a construct.
isOwnedResource Returns true if the construct was created by CDK, and false otherwise.
isResource Check whether the given construct is a Resource.
fromCodeStarConnectionArn Import an externally defined Code Star Connection using its ARN.
isConstruct 
import { GithubCodeStarConnection } from '@jttc/aws-codestarconnection'

GithubCodeStarConnection.isConstruct(x: any)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

xRequired
  • Type: any

Any object.

isOwnedResource 
import { GithubCodeStarConnection } from '@jttc/aws-codestarconnection'

GithubCodeStarConnection.isOwnedResource(construct: IConstruct)

Returns true if the construct was created by CDK, and false otherwise.

constructRequired
  • Type: constructs.IConstruct
isResource 
import { GithubCodeStarConnection } from '@jttc/aws-codestarconnection'

GithubCodeStarConnection.isResource(construct: IConstruct)

Check whether the given construct is a Resource.

constructRequired
  • Type: constructs.IConstruct
fromCodeStarConnectionArn 
import { GithubCodeStarConnection } from '@jttc/aws-codestarconnection'

GithubCodeStarConnection.fromCodeStarConnectionArn(scope: Construct, id: string, codestarConnectionArn: string)

Import an externally defined Code Star Connection using its ARN.

scopeRequired
  • Type: constructs.Construct

the construct that will "own" the imported key.

idRequired
  • Type: string

the id of the imported code star conection in the construct tree.

codestarConnectionArnRequired
  • Type: string

the ARN of an existing Code Star Connection.

Properties

Name Type Description
node constructs.Node The tree node.
env aws-cdk-lib.ResourceEnvironment The environment this resource belongs to.
stack aws-cdk-lib.Stack The stack in which this resource is defined.
connectionArn string The ARN of the Code Star connection.
connectionName string The name of the CodeStar connection.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

envRequired 
public readonly env: ResourceEnvironment;
  • Type: aws-cdk-lib.ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

stackRequired 
public readonly stack: Stack;
  • Type: aws-cdk-lib.Stack

The stack in which this resource is defined.

connectionArnRequired 
public readonly connectionArn: string;
  • Type: string

The ARN of the Code Star connection.

connectionNameRequired 
public readonly connectionName: string;
  • Type: string

The name of the CodeStar connection.

Structs

CodeStarConnectionProps

Initializer 

import { CodeStarConnectionProps } from '@jttc/aws-codestarconnection'

const codeStarConnectionProps: CodeStarConnectionProps = { ... }

Properties

Name Type Description
connectionName string The name of the connection.
providerType CodeStarConnectionProviderType The type of the connection.
hostArn string The Amazon Resource Name (ARN) of the host associated with the connection.
removalPolicy aws-cdk-lib.RemovalPolicy Determine what happens to the code star connection when the resource/stack is deleted.
tags aws-cdk-lib.Tag[] The list of tags associated with the connection.
connectionNameRequired 
public readonly connectionName: string;
  • Type: string

The name of the connection.

Connection names must be in an AWS user account.

providerTypeRequired 
public readonly providerType: CodeStarConnectionProviderType;

The type of the connection.

hostArnOptional 
public readonly hostArn: string;
  • Type: string

The Amazon Resource Name (ARN) of the host associated with the connection.

removalPolicyOptional 
public readonly removalPolicy: RemovalPolicy;
  • Type: aws-cdk-lib.RemovalPolicy
  • Default: RemovalPolicy.Retain

Determine what happens to the code star connection when the resource/stack is deleted.

tagsOptional 
public readonly tags: Tag[];
  • Type: aws-cdk-lib.Tag[]

The list of tags associated with the connection.

GithubCodeStarConnetionProps

Initializer 

import { GithubCodeStarConnetionProps } from '@jttc/aws-codestarconnection'

const githubCodeStarConnetionProps: GithubCodeStarConnetionProps = { ... }

Properties

Name Type Description
connectionName string The name of the connection.
hostArn string The Amazon Resource Name (ARN) of the host associated with the connection.
removalPolicy aws-cdk-lib.RemovalPolicy Determine what happens to the code star connection when the resource/stack is deleted.
tags aws-cdk-lib.Tag[] The list of tags associated with the connection.
connectionNameOptional 
public readonly connectionName: string;
  • Type: string

The name of the connection.

Connection names must be in an AWS user account.

hostArnOptional 
public readonly hostArn: string;
  • Type: string

The Amazon Resource Name (ARN) of the host associated with the connection.

removalPolicyOptional 
public readonly removalPolicy: RemovalPolicy;
  • Type: aws-cdk-lib.RemovalPolicy
  • Default: RemovalPolicy.Retain

Determine what happens to the code star connection when the resource/stack is deleted.

tagsOptional 
public readonly tags: Tag[];
  • Type: aws-cdk-lib.Tag[]

The list of tags associated with the connection.

Protocols

ICodeStarConnection

Methods

Name Description
grant Grant the given principal identity permissions to perform the actions on this code star connection.
grantAdmin Grant the given identity full access to AWS CodeStar Connections so that the user can add, update, and delete connections.
grantConnectionFullAccess Grant the given identity permission to connection full access to the code star connection.
grantRead you want to grant an IAM user in your account read-only access to the connections in your AWS account.
grantUse Grant the given identity permissions to use this code start connection.
grant 
public grant(grantee: IGrantable, actions: string): Grant

Grant the given principal identity permissions to perform the actions on this code star connection.

granteeRequired
  • Type: aws-cdk-lib.aws_iam.IGrantable
actionsRequired
  • Type: string
grantAdmin 
public grantAdmin(grantee: IGrantable): Grant

Grant the given identity full access to AWS CodeStar Connections so that the user can add, update, and delete connections.

granteeRequired
  • Type: aws-cdk-lib.aws_iam.IGrantable
grantConnectionFullAccess 
public grantConnectionFullAccess(grantee: IGrantable): Grant

Grant the given identity permission to connection full access to the code star connection.

granteeRequired
  • Type: aws-cdk-lib.aws_iam.IGrantable
grantRead 
public grantRead(grantee: IGrantable): Grant

you want to grant an IAM user in your account read-only access to the connections in your AWS account.

granteeRequired
  • Type: aws-cdk-lib.aws_iam.IGrantable
grantUse 
public grantUse(grantee: IGrantable): Grant

Grant the given identity permissions to use this code start connection.

granteeRequired
  • Type: aws-cdk-lib.aws_iam.IGrantable

Properties

Name Type Description
node constructs.Node The tree node.
env aws-cdk-lib.ResourceEnvironment The environment this resource belongs to.
stack aws-cdk-lib.Stack The stack in which this resource is defined.
connectionArn string The ARN of the connection.
connectionName string The name of the connection.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

envRequired 
public readonly env: ResourceEnvironment;
  • Type: aws-cdk-lib.ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

stackRequired 
public readonly stack: Stack;
  • Type: aws-cdk-lib.Stack

The stack in which this resource is defined.

connectionArnRequired 
public readonly connectionArn: string;
  • Type: string

The ARN of the connection.

connectionNameRequired 
public readonly connectionName: string;
  • Type: string

The name of the connection.

Connection names must be in an AWS user account.

Enums

CodeStarConnectionPolicyActions

Actions defined by AWS CodeStar Connections Service prefix: codestar-connections.

The Resource Type indicates whether each action supports resource-level permissions. If there is no value, you must specify all resources ("*") to which the policy applies in the Resource element of your policy statement

The Condition Keys includes keys that you can specify in a policy statement's Condition element

Members

Name Description
CREATE_CONNECTION Grants permission to create a Connection resource.
CREATE_HOST Grants permission to create a Host resource.
DELETE_CONNECTION Grants permission to delete a Connection resource.
DELETE_HOST Grants permission to delete a host resource.
GET_CONNECTION Grants permission to get details about a Connection resource.
GET_HOST Grants permission to get details about a host resource.
GET_INDIVIDUAL_ACCESS_TOKEN Grants permission to associate a third party, such as a Bitbucket App installation, with a Connection.
GET_INSTALLATION_URL_FOR_APP Grants permission to associate a third party, such as a Bitbucket App installation, with a Connection.
GET_INSTALLATION_URL_FOR_HOST Grants permission to get the URL to authorize an installation in a third party app.
GET_INSTALLATION_URL Grants permission to get the URL to authorize an installation in a third party app.
LIST_CONNECTIONS Grants permission to list Connection resources.
LIST_HOSTS Grants permission to list host resources.
LIST_INDIVIDUAL_ACCESS_TOKENS Grants permission to list individual access token.
LIST_INSTALLATIONS Grants permission to list installations.
LIST_INSTALLATION_TARGETS Grants permission to associate a third party, such as a Bitbucket App installation, with a Connection.
LIST_PASS_CONNECTIONS Grants permission to list pass connections.
LIST_TAGS_FOR_RESOURCE Grants permission to the set of key-value pairs that are used to manage the resource.
PASS_CONNECTION Grants permission to pass a Connection resource to an AWS service that accepts a Connection ARN as input, such as codepipeline:CreatePipeline.
REGISTER_APP_CODE Grants permission to associate a third party server, such as a GitHub Enterprise Server instance, with a Host.
START_APP_REGISTRATION_HANDSHAKE Grants permission to associate a third party server, such as a GitHub Enterprise Server instance, with a Host.
START_OAUTH_HANDSHAKE Grants permission to associate a third party, such as a Bitbucket App installation, with a Connection.
TAG_RESOURCE Grants permission to add or modify the tags of the given resource.
UNTAG_RESOURCE Grants permission to remove tags from an AWS resource.
UPDATE_CONNECTION_INSTALLATION Grants permission to update a Connection resource with an installation of the CodeStar Connections App.
UPDATE_HOST Grants permission to update a host resource.
USE_CONNECTION Grants permission to use a Connection resource to call provider actions.
CREATE_CONNECTION

Grants permission to create a Connection resource.

CREATE_HOST

Grants permission to create a Host resource.

DELETE_CONNECTION

Grants permission to delete a Connection resource.

DELETE_HOST

Grants permission to delete a host resource.

GET_CONNECTION

Grants permission to get details about a Connection resource.

GET_HOST

Grants permission to get details about a host resource.

GET_INDIVIDUAL_ACCESS_TOKEN

Grants permission to associate a third party, such as a Bitbucket App installation, with a Connection.

GET_INSTALLATION_URL_FOR_APP

Grants permission to associate a third party, such as a Bitbucket App installation, with a Connection.

GET_INSTALLATION_URL_FOR_HOST

Grants permission to get the URL to authorize an installation in a third party app.

GET_INSTALLATION_URL

Grants permission to get the URL to authorize an installation in a third party app.

LIST_CONNECTIONS

Grants permission to list Connection resources.

LIST_HOSTS

Grants permission to list host resources.

LIST_INDIVIDUAL_ACCESS_TOKENS

Grants permission to list individual access token.

LIST_INSTALLATIONS

Grants permission to list installations.

LIST_INSTALLATION_TARGETS

Grants permission to associate a third party, such as a Bitbucket App installation, with a Connection.

LIST_PASS_CONNECTIONS

Grants permission to list pass connections.

LIST_TAGS_FOR_RESOURCE

Grants permission to the set of key-value pairs that are used to manage the resource.

PASS_CONNECTION

Grants permission to pass a Connection resource to an AWS service that accepts a Connection ARN as input, such as codepipeline:CreatePipeline.

REGISTER_APP_CODE

Grants permission to associate a third party server, such as a GitHub Enterprise Server instance, with a Host.

START_APP_REGISTRATION_HANDSHAKE

Grants permission to associate a third party server, such as a GitHub Enterprise Server instance, with a Host.

START_OAUTH_HANDSHAKE

Grants permission to associate a third party, such as a Bitbucket App installation, with a Connection.

TAG_RESOURCE

Grants permission to add or modify the tags of the given resource.

UNTAG_RESOURCE

Grants permission to remove tags from an AWS resource.

UPDATE_CONNECTION_INSTALLATION

Grants permission to update a Connection resource with an installation of the CodeStar Connections App.

UPDATE_HOST

Grants permission to update a host resource.

USE_CONNECTION

Grants permission to use a Connection resource to call provider actions.

CodeStarConnectionProviderType

Connection Provider Type supported.

Members

Name Description
GITHUB Github provider.
GITHUB_ENTERPRISE Github Entrprise provider.
GITLAB Gitlab Provider.
BITBUCKET Bitbucket Provider.
GITHUB

Github provider.

GITHUB_ENTERPRISE

Github Entrprise provider.

GITLAB

Gitlab Provider.

BITBUCKET

Bitbucket Provider.