API Reference

Constructs

GithubCustomResource

new GithubCustomResource(scope, "GithubRepo", {
  onCreate: {
    // https://octokit.github.io/rest.js/v19/#repos-create-in-org
    endpoint: "repos",
    method: "createInOrg",
    parameters: {
      org: "pepperize",
      name: "cdk-github",
    },
    outputPaths: ["id", "full_name"],
    physicalResourceId: custom_resources.PhysicalResourceId.fromResponse("full_name"),
    ignoreErrorCodesMatching: "name already exists on this account",
  },
  onUpdate: {
    // https://octokit.github.io/rest.js/v19#repos-get
    endpoint: "repos",
    method: "get",
    parameters: {
      owner: "pepperize",
      repo: "cdk-github",
    },
    outputPaths: ["id", "full_name"],
    physicalResourceId: custom_resources.PhysicalResourceId.fromResponse("full_name"),
  },
  onDelete: {
    // https://octokit.github.io/rest.js/v19#repos-delete
    endpoint: "repos",
    method: "delete",
    parameters: {
      owner: "pepperize",
      repo: "cdk-github",
    },
    outputPaths: [],
  },
  authOptions: AuthOptions.appAuth(auth),
});

Initializers

import { GithubCustomResource } from '@pepperize/cdk-github'

new GithubCustomResource(scope: Construct, id: string, props: GithubCustomResourceProps)

Name	Type	Description
`scope`	`constructs.Construct`	No description.
`id`	`string`	No description.
`props`	`GithubCustomResourceProps`	No description.

`scope`^Required

Type: constructs.Construct

`id`^Required

Type: string

`props`^Required

Type: GithubCustomResourceProps

Methods

Name	Description
`toString`	Returns a string representation of this construct.
`getAtt`	Returns the value of an attribute of the custom resource of an arbitrary type.
`getAttString`	Returns the value of an attribute of the custom resource of type string.

`toString`

public toString(): string

Returns a string representation of this construct.

`getAtt`

public getAtt(attributeName: string): Reference

Returns the value of an attribute of the custom resource of an arbitrary type.

Attributes are returned from the custom resource provider through the Data map where the key is the attribute name.

`attributeName`^Required

Type: string

the name of the attribute.

`getAttString`

public getAttString(attributeName: string): string

Returns the value of an attribute of the custom resource of type string.

Attributes are returned from the custom resource provider through the Data map where the key is the attribute name.

`attributeName`^Required

Type: string

the name of the attribute.

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.

`isConstruct`

import { GithubCustomResource } from '@pepperize/cdk-github'

GithubCustomResource.isConstruct(x: any)

Checks if x is a construct.

`x`^Required

Type: any

Any object.

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.
`ref`	`string`	The physical name of this custom resource.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`ref`^Required

public readonly ref: string;

Type: string

The physical name of this custom resource.

GithubCustomResourceBase

Initializers

import { GithubCustomResourceBase } from '@pepperize/cdk-github'

new GithubCustomResourceBase(scope: Construct, id: string)

Name	Type	Description
`scope`	`constructs.Construct`	The scope in which to define this construct.
`id`	`string`	The scoped construct ID.

`scope`^Required

Type: constructs.Construct

The scope in which to define this construct.

`id`^Required

Type: string

The scoped construct ID.

Must be unique amongst siblings. If the ID includes a path separator (/), then it will be replaced by double dash --.

Methods

Name	Description
`toString`	Returns a string representation of this construct.
`getAtt`	Returns the value of an attribute of the custom resource of an arbitrary type.
`getAttString`	Returns the value of an attribute of the custom resource of type string.

`toString`

public toString(): string

Returns a string representation of this construct.

`getAtt`

public getAtt(attributeName: string): Reference

Returns the value of an attribute of the custom resource of an arbitrary type.

Attributes are returned from the custom resource provider through the Data map where the key is the attribute name.

`attributeName`^Required

Type: string

the name of the attribute.

`getAttString`

public getAttString(attributeName: string): string

Returns the value of an attribute of the custom resource of type string.

Attributes are returned from the custom resource provider through the Data map where the key is the attribute name.

`attributeName`^Required

Type: string

the name of the attribute.

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.

`isConstruct`

import { GithubCustomResourceBase } from '@pepperize/cdk-github'

GithubCustomResourceBase.isConstruct(x: any)

Checks if x is a construct.

`x`^Required

Type: any

Any object.

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.
`ref`	`string`	The physical name of this custom resource.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`ref`^Required

public readonly ref: string;

Type: string

The physical name of this custom resource.

Structs

GithubApiCall

Initializer

import { GithubApiCall } from '@pepperize/cdk-github'

const githubApiCall: GithubApiCall = { ... }

Properties

Name	Type	Description
`endpoint`	`string`	The endpoint to call.
`method`	`string`	The method to call.
`ignoreErrorCodesMatching`	`string`	The regex pattern to use to catch API errors.
`outputPaths`	`string[]`	Filter the data returned by the custom resource to specific paths in the API response.
`parameters`	`any`	The parameters for the service action.
`physicalResourceId`	`aws-cdk-lib.custom_resources.PhysicalResourceId`	The physical resource id of the custom resource for this call.

`endpoint`^Required

public readonly endpoint: string;

Type: string

The endpoint to call.

https://github.com/octokit/rest.js

`method`^Required

public readonly method: string;

Type: string

The method to call.

https://github.com/octokit/rest.js

`ignoreErrorCodesMatching`^Optional

public readonly ignoreErrorCodesMatching: string;

Type: string

The regex pattern to use to catch API errors.

The message property of the RequestError object will be tested against this pattern. If there is a match an error will not be thrown.

`outputPaths`^Optional

public readonly outputPaths: string[];

Type: string[]
Default: undefined - it's recommended to define it

Filter the data returned by the custom resource to specific paths in the API response.

The total size of the response body can't exceed 4096 bytes.

[https://docs.github.com/en/rest

Example for octokit.rest.repos.createInOrg: ['id', 'full_name', 'owner.id']](https://docs.github.com/en/rest

Example for octokit.rest.repos.createInOrg: ['id', 'full_name', 'owner.id'])

`parameters`^Optional

public readonly parameters: any;

Type: any

The parameters for the service action.

https://github.com/octokit/rest.js

`physicalResourceId`^Optional

public readonly physicalResourceId: PhysicalResourceId;

Type: aws-cdk-lib.custom_resources.PhysicalResourceId
Default: undefined - for "Create" requests, defaults to the event's RequestId, for "Update" and "Delete", defaults to the current PhysicalResourceId.

The physical resource id of the custom resource for this call.

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/crpg-ref-responses.html

GithubCustomResourceOptions

Initializer

import { GithubCustomResourceOptions } from '@pepperize/cdk-github'

const githubCustomResourceOptions: GithubCustomResourceOptions = { ... }

Properties

Name	Type	Description
`authOptions`	`IAuthOptions`	Currently, supports only GitHub App.

`authOptions`^Required

public readonly authOptions: IAuthOptions;

Type: IAuthOptions

Currently, supports only GitHub App.

const auth = { appId, privateKey };
const installationAuth = { appId, privateKey, installationId };

https://github.com/octokit/authentication-strategies.js/#github-app-or-installation-authentication

GithubCustomResourceProps

Initializer

import { GithubCustomResourceProps } from '@pepperize/cdk-github'

const githubCustomResourceProps: GithubCustomResourceProps = { ... }

Properties

Name	Type	Description
`authOptions`	`IAuthOptions`	Currently, supports only GitHub App.
`onCreate`	`GithubApiCall`	The GitHub Api call to make when the resource is created.
`onDelete`	`GithubApiCall`	The GitHub Api call to make when the resource is deleted.
`onUpdate`	`GithubApiCall`	The GitHub Api call to make when the resource is updated.
`resourceType`	`string`	Cloudformation Resource type.

`authOptions`^Required

public readonly authOptions: IAuthOptions;

Type: IAuthOptions

Currently, supports only GitHub App.

const auth = { appId, privateKey };
const installationAuth = { appId, privateKey, installationId };

https://github.com/octokit/authentication-strategies.js/#github-app-or-installation-authentication

`onCreate`^Optional

public readonly onCreate: GithubApiCall;

Type: GithubApiCall

The GitHub Api call to make when the resource is created.

`onDelete`^Optional

public readonly onDelete: GithubApiCall;

Type: GithubApiCall

The GitHub Api call to make when the resource is deleted.

`onUpdate`^Optional

public readonly onUpdate: GithubApiCall;

Type: GithubApiCall

The GitHub Api call to make when the resource is updated.

`resourceType`^Optional

public readonly resourceType: string;

Type: string

Cloudformation Resource type.

Classes

AuthOptions

Implements: IAuthOptions

Initializers

import { AuthOptions } from '@pepperize/cdk-github'

new AuthOptions()

Name	Type	Description

Static Functions

Name	Description
`appAuth`	GitHub App or installation authentication.
`tokenAuth`	Personal Access Token authentication.
`unauthenticated`	unauthenticated.

`appAuth`

import { AuthOptions } from '@pepperize/cdk-github'

AuthOptions.appAuth(secret: ISecret)

GitHub App or installation authentication.

https://github.com/octokit/auth-app.js/#readme

`secret`^Required

Type: aws-cdk-lib.aws_secretsmanager.ISecret

`tokenAuth`

import { AuthOptions } from '@pepperize/cdk-github'

AuthOptions.tokenAuth(parameter: IParameter)

Personal Access Token authentication.

https://github.com/octokit/auth-token.js#readme

`parameter`^Required

Type: aws-cdk-lib.aws_ssm.IParameter

`unauthenticated`

import { AuthOptions } from '@pepperize/cdk-github'

AuthOptions.unauthenticated()

unauthenticated.

https://github.com/octokit/auth-unauthenticated.js#readme

Protocols

IAuthOptions

Implemented By: AuthOptions, IAuthOptions

Files

API.md

Latest commit

History

API.md

File metadata and controls

API Reference

Constructs

GithubCustomResource

Initializers

scopeRequired

idRequired

propsRequired

Methods

toString

getAtt

attributeNameRequired

getAttString

attributeNameRequired

Static Functions

isConstruct

xRequired

Properties

nodeRequired

refRequired

GithubCustomResourceBase

Initializers

scopeRequired

idRequired

Methods

toString

getAtt

attributeNameRequired

getAttString

attributeNameRequired

Static Functions

isConstruct

xRequired

Properties

nodeRequired

refRequired

Structs

GithubApiCall

Initializer

Properties

endpointRequired

methodRequired

ignoreErrorCodesMatchingOptional

outputPathsOptional

parametersOptional

physicalResourceIdOptional

GithubCustomResourceOptions

Initializer

Properties

authOptionsRequired

GithubCustomResourceProps

Initializer

Properties

authOptionsRequired

onCreateOptional

onDeleteOptional

onUpdateOptional

resourceTypeOptional

Classes

AuthOptions

Initializers

Static Functions

appAuth

secretRequired

tokenAuth

parameterRequired

unauthenticated

Protocols

IAuthOptions

`scope`^Required

`id`^Required

`props`^Required

`toString`

`getAtt`

`attributeName`^Required

`getAttString`

`attributeName`^Required

`isConstruct`

`x`^Required

`node`^Required

`ref`^Required

`scope`^Required

`id`^Required

`toString`

`getAtt`

`attributeName`^Required

`getAttString`

`attributeName`^Required

`isConstruct`

`x`^Required

`node`^Required

`ref`^Required

`endpoint`^Required

`method`^Required

`ignoreErrorCodesMatching`^Optional

`outputPaths`^Optional

`parameters`^Optional

`physicalResourceId`^Optional

`authOptions`^Required

`authOptions`^Required

`onCreate`^Optional

`onDelete`^Optional

`onUpdate`^Optional

`resourceType`^Optional

`appAuth`

`secret`^Required

`tokenAuth`

`parameter`^Required

`unauthenticated`