Skip to content

Latest commit

 

History

History
1085 lines (642 loc) · 36.1 KB

API.md

File metadata and controls

1085 lines (642 loc) · 36.1 KB
Raw

API Reference

Constructs

BitBucketProject

BitBucket project using {@link project-custom-resource#BitBucketProjectCustomResource BitBucketProjectCustomResource}.

Initializers 

import { BitBucketProject } from '@pgarbe/cdk-bitbucket-server'

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

Methods

Name Description
toString Returns a string representation of this construct.
toString 
public toString(): string

Returns a string representation of this construct.

Static Functions

Name Description
isConstruct Checks if x is a construct.
isConstruct 
import { BitBucketProject } from '@pgarbe/cdk-bitbucket-server'

BitBucketProject.isConstruct(x: any)

Checks if x is a construct.

xRequired
  • Type: any

Any object.

Properties

Name Type Description
node constructs.Node The tree node.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

BitBucketProjectCustomResource

  • Implements: aws-cdk-lib.aws_iam.IGrantable

Custom Resource provider to create a BitBucket project.

Initializers 

import { BitBucketProjectCustomResource } from '@pgarbe/cdk-bitbucket-server'

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

Methods

Name Description
toString Returns a string representation of this construct.
toString 
public toString(): string

Returns a string representation of this construct.

Static Functions

Name Description
isConstruct Checks if x is a construct.
isConstruct 
import { BitBucketProjectCustomResource } from '@pgarbe/cdk-bitbucket-server'

BitBucketProjectCustomResource.isConstruct(x: any)

Checks if x is a construct.

xRequired
  • Type: any

Any object.

Properties

Name Type Description
node constructs.Node The tree node.
grantPrincipal aws-cdk-lib.aws_iam.IPrincipal The principal to grant permissions to.
serviceToken string The service token to be used in custom resources.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

grantPrincipalRequired 
public readonly grantPrincipal: IPrincipal;
  • Type: aws-cdk-lib.aws_iam.IPrincipal

The principal to grant permissions to.

serviceTokenRequired 
public readonly serviceToken: string;
  • Type: string

The service token to be used in custom resources.

BitBucketRepo

BitBucket repository using {@link repository-custom-resource#BitBucketRepoCustomResource BitBucketRepoCustomResource}.

Initializers 

import { BitBucketRepo } from '@pgarbe/cdk-bitbucket-server'

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

Methods

Name Description
toString Returns a string representation of this construct.
toString 
public toString(): string

Returns a string representation of this construct.

Static Functions

Name Description
isConstruct Checks if x is a construct.
isConstruct 
import { BitBucketRepo } from '@pgarbe/cdk-bitbucket-server'

BitBucketRepo.isConstruct(x: any)

Checks if x is a construct.

xRequired
  • Type: any

Any object.

Properties

Name Type Description
node constructs.Node The tree node.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

BitBucketRepoCustomResource

  • Implements: aws-cdk-lib.aws_iam.IGrantable

Custom Resource provider to create a BitBucket repository.

Initializers 

import { BitBucketRepoCustomResource } from '@pgarbe/cdk-bitbucket-server'

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

Methods

Name Description
toString Returns a string representation of this construct.
toString 
public toString(): string

Returns a string representation of this construct.

Static Functions

Name Description
isConstruct Checks if x is a construct.
isConstruct 
import { BitBucketRepoCustomResource } from '@pgarbe/cdk-bitbucket-server'

BitBucketRepoCustomResource.isConstruct(x: any)

Checks if x is a construct.

xRequired
  • Type: any

Any object.

Properties

Name Type Description
node constructs.Node The tree node.
grantPrincipal aws-cdk-lib.aws_iam.IPrincipal The principal to grant permissions to.
serviceToken string The service token to be used in custom resources.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

grantPrincipalRequired 
public readonly grantPrincipal: IPrincipal;
  • Type: aws-cdk-lib.aws_iam.IPrincipal

The principal to grant permissions to.

serviceTokenRequired 
public readonly serviceToken: string;
  • Type: string

The service token to be used in custom resources.

BitBucketWebHook

BitBucket Webhook using {@link webhook-custom-resource#BitBucketWebHookCustomResource BitBucketWebHookCustomResource}.

Initializers 

import { BitBucketWebHook } from '@pgarbe/cdk-bitbucket-server'

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

Methods

Name Description
toString Returns a string representation of this construct.
toString 
public toString(): string

Returns a string representation of this construct.

Static Functions

Name Description
isConstruct Checks if x is a construct.
isConstruct 
import { BitBucketWebHook } from '@pgarbe/cdk-bitbucket-server'

BitBucketWebHook.isConstruct(x: any)

Checks if x is a construct.

xRequired
  • Type: any

Any object.

Properties

Name Type Description
node constructs.Node The tree node.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

BitBucketWebHookCustomResource

  • Implements: aws-cdk-lib.aws_iam.IGrantable

Custom Resource provider to create a BitBucket Webhook.

Initializers 

import { BitBucketWebHookCustomResource } from '@pgarbe/cdk-bitbucket-server'

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

Methods

Name Description
toString Returns a string representation of this construct.
toString 
public toString(): string

Returns a string representation of this construct.

Static Functions

Name Description
isConstruct Checks if x is a construct.
isConstruct 
import { BitBucketWebHookCustomResource } from '@pgarbe/cdk-bitbucket-server'

BitBucketWebHookCustomResource.isConstruct(x: any)

Checks if x is a construct.

xRequired
  • Type: any

Any object.

Properties

Name Type Description
node constructs.Node The tree node.
grantPrincipal aws-cdk-lib.aws_iam.IPrincipal The principal to grant permissions to.
serviceToken string The service token to be used in custom resources.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

grantPrincipalRequired 
public readonly grantPrincipal: IPrincipal;
  • Type: aws-cdk-lib.aws_iam.IPrincipal

The principal to grant permissions to.

serviceTokenRequired 
public readonly serviceToken: string;
  • Type: string

The service token to be used in custom resources.

Structs

BitBucketProjectCustomResourceProps

Props of BitBucketProjectCustomResource.

Initializer 

import { BitBucketProjectCustomResourceProps } from '@pgarbe/cdk-bitbucket-server'

const bitBucketProjectCustomResourceProps: BitBucketProjectCustomResourceProps = { ... }

Properties

Name Type Description
host string BitBucket server.
passwordSsmPath string Path of SSM param that includes the BitBucket password.
usernameSsmPath string Path of SSM param that includes the BitBucket username.
hostRequired 
public readonly host: string;
  • Type: string

BitBucket server.

passwordSsmPathRequired 
public readonly passwordSsmPath: string;
  • Type: string

Path of SSM param that includes the BitBucket password.

usernameSsmPathRequired 
public readonly usernameSsmPath: string;
  • Type: string

Path of SSM param that includes the BitBucket username.

BitBucketProjectProps

Props of BitBucketProject.

Initializer 

import { BitBucketProjectProps } from '@pgarbe/cdk-bitbucket-server'

const bitBucketProjectProps: BitBucketProjectProps = { ... }

Properties

Name Type Description
description string Description of the project.
key string Key of the project.
name string Name of the project.
serviceToken string Token returned by {@link project-custom-resource#BitBucketProjectCustomResource BitBucketProjectCustomResource}.
descriptionRequired 
public readonly description: string;
  • Type: string

Description of the project.

keyRequired 
public readonly key: string;
  • Type: string

Key of the project.

nameRequired 
public readonly name: string;
  • Type: string

Name of the project.

serviceTokenRequired 
public readonly serviceToken: string;
  • Type: string

Token returned by {@link project-custom-resource#BitBucketProjectCustomResource BitBucketProjectCustomResource}.

BitBucketRepoCustomResourceProps

Props of BitBucketRepoCustomResource.

Initializer 

import { BitBucketRepoCustomResourceProps } from '@pgarbe/cdk-bitbucket-server'

const bitBucketRepoCustomResourceProps: BitBucketRepoCustomResourceProps = { ... }

Properties

Name Type Description
host string BitBucket server.
passwordSsmPath string Path of SSM param that includes the BitBucket password.
usernameSsmPath string Path of SSM param that includes the BitBucket username.
hostRequired 
public readonly host: string;
  • Type: string

BitBucket server.

passwordSsmPathRequired 
public readonly passwordSsmPath: string;
  • Type: string

Path of SSM param that includes the BitBucket password.

usernameSsmPathRequired 
public readonly usernameSsmPath: string;
  • Type: string

Path of SSM param that includes the BitBucket username.

BitBucketRepoProps

Props of BitBucketRepo.

Initializer 

import { BitBucketRepoProps } from '@pgarbe/cdk-bitbucket-server'

const bitBucketRepoProps: BitBucketRepoProps = { ... }

Properties

Name Type Description
projectName string Name of the project.
repositorySlug string Slug of the repository.
serviceToken string Token returned by {@link repository-custom-resource#BitBucketRepoCustomResource BitBucketRepoCustomResource}.
projectNameRequired 
public readonly projectName: string;
  • Type: string

Name of the project.

repositorySlugRequired 
public readonly repositorySlug: string;
  • Type: string

Slug of the repository.

serviceTokenRequired 
public readonly serviceToken: string;
  • Type: string

Token returned by {@link repository-custom-resource#BitBucketRepoCustomResource BitBucketRepoCustomResource}.

BitBucketWebHookCustomResourceProps

Props of BitBucketWebHookCustomResource.

Initializer 

import { BitBucketWebHookCustomResourceProps } from '@pgarbe/cdk-bitbucket-server'

const bitBucketWebHookCustomResourceProps: BitBucketWebHookCustomResourceProps = { ... }

Properties

Name Type Description
host string BitBucket server.
passwordSsmPath string Path of SSM param that includes the BitBucket password.
usernameSsmPath string Path of SSM param that includes the BitBucket username.
hostRequired 
public readonly host: string;
  • Type: string

BitBucket server.

passwordSsmPathRequired 
public readonly passwordSsmPath: string;
  • Type: string

Path of SSM param that includes the BitBucket password.

usernameSsmPathRequired 
public readonly usernameSsmPath: string;
  • Type: string

Path of SSM param that includes the BitBucket username.

BitBucketWebHookProps

Props of BitBucketWebHook.

Initializer 

import { BitBucketWebHookProps } from '@pgarbe/cdk-bitbucket-server'

const bitBucketWebHookProps: BitBucketWebHookProps = { ... }

Properties

Name Type Description
events string[] List of events that trigger the webhook.
name string Name of the webhook.
secret string Secret of the webhook.
serviceToken string Token returned by {@link webhook-custom-resource#BitBucketWebHookCustomResource BitBucketWebHookCustomResource}.
url string URL that is called by the webhook.
eventsRequired 
public readonly events: string[];
  • Type: string[]

List of events that trigger the webhook.

nameRequired 
public readonly name: string;
  • Type: string

Name of the webhook.

secretRequired 
public readonly secret: string;
  • Type: string

Secret of the webhook.

serviceTokenRequired 
public readonly serviceToken: string;
  • Type: string

Token returned by {@link webhook-custom-resource#BitBucketWebHookCustomResource BitBucketWebHookCustomResource}.

urlRequired 
public readonly url: string;
  • Type: string

URL that is called by the webhook.