Skip to content

Latest commit

 

History

History
361 lines (214 loc) · 15.3 KB

API.md

File metadata and controls

361 lines (214 loc) · 15.3 KB

API Reference

Constructs

CodeConnectionsHostCustomResource

Initializers 

import { CodeConnectionsHostCustomResource } from '@gammarers/aws-codeconnections-host-custom-resource'

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

Methods

Name Description
toString Returns a string representation of this construct.
getResponseField Returns response data for the AWS SDK call as string.
getResponseFieldReference Returns response data for the AWS SDK call.
findHostArn No description.
toString 
public toString(): string

Returns a string representation of this construct.

getResponseField 
public getResponseField(dataPath: string): string

Returns response data for the AWS SDK call as string.

Example for S3 / listBucket : 'Buckets.0.Name'

Note that you cannot use this method if ignoreErrorCodesMatching is configured for any of the SDK calls. This is because in such a case, the response data might not exist, and will cause a CloudFormation deploy time error.

dataPathRequired
  • Type: string

the path to the data.

getResponseFieldReference 
public getResponseFieldReference(dataPath: string): Reference

Returns response data for the AWS SDK call.

Example for S3 / listBucket : 'Buckets.0.Name'

Use Token.asXxx to encode the returned Reference as a specific type or use the convenience getDataString for string attributes.

Note that you cannot use this method if ignoreErrorCodesMatching is configured for any of the SDK calls. This is because in such a case, the response data might not exist, and will cause a CloudFormation deploy time error.

dataPathRequired
  • Type: string

the path to the data.

findHostArn 
public findHostArn(): string

Static Functions

Name Description
isConstruct Checks if x is a construct.
isConstruct 
import { CodeConnectionsHostCustomResource } from '@gammarers/aws-codeconnections-host-custom-resource'

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

Constants

Name Type Description
PROVIDER_FUNCTION_UUID string The uuid of the custom resource provider singleton lambda function.
PROVIDER_FUNCTION_UUIDRequired 
public readonly PROVIDER_FUNCTION_UUID: string;
  • Type: string

The uuid of the custom resource provider singleton lambda function.

Structs

CodeConnectionsHostCustomResourceProps

Initializer 

import { CodeConnectionsHostCustomResourceProps } from '@gammarers/aws-codeconnections-host-custom-resource'

const codeConnectionsHostCustomResourceProps: CodeConnectionsHostCustomResourceProps = { ... }

Properties

Name Type Description
name string No description.
providerEndpoint string No description.
providerType CodeConnectionsHostProviderType No description.
resourceNamingOption CustomNaming | @gammarers/aws-resource-naming.ResourceDefaultNaming | @gammarers/aws-resource-naming.ResourceAutoNaming No description.
nameRequired 
public readonly name: string;
  • Type: string
providerEndpointRequired 
public readonly providerEndpoint: string;
  • Type: string
providerTypeRequired 
public readonly providerType: CodeConnectionsHostProviderType;
resourceNamingOptionOptional 
public readonly resourceNamingOption: CustomNaming | ResourceDefaultNaming | ResourceAutoNaming;
  • Type: CustomNaming | @gammarers/aws-resource-naming.ResourceDefaultNaming | @gammarers/aws-resource-naming.ResourceAutoNaming

CustomNaming

Initializer 

import { CustomNaming } from '@gammarers/aws-codeconnections-host-custom-resource'

const customNaming: CustomNaming = { ... }

Properties

Name Type Description
functionName string No description.
functionRoleName string No description.
type @gammarers/aws-resource-naming.ResourceNamingType No description.
functionNameRequired 
public readonly functionName: string;
  • Type: string
functionRoleNameRequired 
public readonly functionRoleName: string;
  • Type: string
typeRequired 
public readonly type: ResourceNamingType;
  • Type: @gammarers/aws-resource-naming.ResourceNamingType

Enums

CodeConnectionsHostProviderType

Members

Name Description
BIT_BUCKET No description.
GIT_HUB No description.
GIT_HUB_ENTERPRISE_SERVER No description.
GIT_LAB No description.
GIT_LAB_SELF_MANAGED No description.
BIT_BUCKET
GIT_HUB
GIT_HUB_ENTERPRISE_SERVER
GIT_LAB
GIT_LAB_SELF_MANAGED

ResponseField

Members

Name Description
HOST_ARN No description.
HOST_ARN