Skip to content

Latest commit

 

History

History
470 lines (279 loc) · 17.2 KB

API.md

File metadata and controls

470 lines (279 loc) · 17.2 KB
Raw

API Reference

Constructs

CustomResourceProvider

Initializers 

import { CustomResourceProvider } from 'halloumi-cross-account-parameter-store'

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

Methods

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

Returns a string representation of this construct.

gProviderFramework 
public gProviderFramework(): Provider

Static Functions

Name Description
isConstruct Checks if x is a construct.
isConstruct 
import { CustomResourceProvider } from 'halloumi-cross-account-parameter-store'

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

FunctionConstruct

Initializers 

import { FunctionConstruct } from 'halloumi-cross-account-parameter-store'

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

Methods

Name Description
toString Returns a string representation of this construct.
gFunction Get the function.
gFunctionRole Get the IAM Role attached to the function.
toString 
public toString(): string

Returns a string representation of this construct.

gFunction 
public gFunction(): IFunction

Get the function.

gFunctionRole 
public gFunctionRole(): IRole

Get the IAM Role attached to the function.

Static Functions

Name Description
isConstruct Checks if x is a construct.
isConstruct 
import { FunctionConstruct } from 'halloumi-cross-account-parameter-store'

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

HalloumiCrossAccountParameterStore

Initializers 

import { HalloumiCrossAccountParameterStore } from 'halloumi-cross-account-parameter-store'

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

Methods

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

Returns a string representation of this construct.

createParameterManager 
public createParameterManager(id: string): CustomResource
idRequired
  • Type: string

Static Functions

Name Description
isConstruct Checks if x is a construct.
isConstruct 
import { HalloumiCrossAccountParameterStore } from 'halloumi-cross-account-parameter-store'

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

Structs

FunctionProps

Initializer 

import { FunctionProps } from 'halloumi-cross-account-parameter-store'

const functionProps: FunctionProps = { ... }

Properties

Name Type Description
roleArn string The ARN of the role on the target account that the STS client on the Lambda function assumes and has permissions to create, update and delete a parameter on that account.
roleExternalId string Optional: Information that you can use in an IAM role trust policy to designate who can assume the role.
roleSessionName string Optional: IAM role session name when STS client on the Lambda function assumes the role on the target account.
roleArnRequired 
public readonly roleArn: string;
  • Type: string

The ARN of the role on the target account that the STS client on the Lambda function assumes and has permissions to create, update and delete a parameter on that account.

roleExternalIdOptional 
public readonly roleExternalId: string;
  • Type: string

Optional: Information that you can use in an IAM role trust policy to designate who can assume the role.

roleSessionNameOptional 
public readonly roleSessionName: string;
  • Type: string

Optional: IAM role session name when STS client on the Lambda function assumes the role on the target account.

Default is halloumi_cross_account_parameter_store.

ParameterManagerProps

Initializer 

import { ParameterManagerProps } from 'halloumi-cross-account-parameter-store'

const parameterManagerProps: ParameterManagerProps = { ... }

Properties

Name Type Description
customResourceProvider CustomResourceProvider An instance of the CustomResourceProvider.
parameterDescription string A description for the parameter.
parameterName string The name of the parameter on the target account that is going to be managed.
parameterValue any The value of the parameter on the target account.
customResourceProviderRequired 
public readonly customResourceProvider: CustomResourceProvider;

An instance of the CustomResourceProvider.

parameterDescriptionRequired 
public readonly parameterDescription: string;
  • Type: string

A description for the parameter.

parameterNameRequired 
public readonly parameterName: string;
  • Type: string

The name of the parameter on the target account that is going to be managed.

parameterValueRequired 
public readonly parameterValue: any;
  • Type: any

The value of the parameter on the target account.