Skip to main content

AWSDeployerParameters

@webda/aws

Class: AWSDeployerParameters

Defined in: aws/src/deployers/awsdeployer.ts:42

Common parameters of the AWS deployers

A deployer is declared as a unit of a deployment (deployments/<name>.json), its parameters can use the ${...} deployment variables (getDeploymentVariables)

Extends​

  • ServiceParameters

Extended by​

Constructors​

Constructor​

new AWSDeployerParameters(): AWSDeployerParameters

Returns​

AWSDeployerParameters

Inherited from​

ServiceParameters.constructor

Properties​

accessKeyId?​

optional accessKeyId?: string

Defined in: aws/src/deployers/awsdeployer.ts:52

AWS_ACCESS_KEY_ID to use

Using static key is not recommended

AWSAccountId?​

optional AWSAccountId?: string

Defined in: aws/src/deployers/awsdeployer.ts:76

AWS Account Id

Certificates?​

optional Certificates?: object

Defined in: aws/src/deployers/awsdeployer.ts:98

SSL certificates to create

Sample

Certificates: {
  "test.webda.io": {
     SubjectAlternativeNames: ["test2.webda.io"]
  }
}

Index Signature​

[key: string]: object

endpoints?​

optional endpoints?: object

Defined in: aws/src/deployers/awsdeployer.ts:81

Endpoints to use by differents services Usefull to test with localstack or other AWS emulations

ACM?​

optional ACM?: string

APIGateway?​

optional APIGateway?: string

CloudFormation?​

optional CloudFormation?: string

CloudFront?​

optional CloudFront?: string

EC2?​

optional EC2?: string

Route53?​

optional Route53?: string

S3?​

optional S3?: string

STS?​

optional STS?: string

name?​

optional name?: string

Defined in: aws/src/deployers/awsdeployer.ts:46

Name of the unit

region?​

optional region?: string

Defined in: aws/src/deployers/awsdeployer.ts:72

AWS_REGION to use

Default​

"us-east-1"

secretAccessKey?​

optional secretAccessKey?: string

Defined in: aws/src/deployers/awsdeployer.ts:58

AWS_SECRET_ACCESS_KEY to use

Using static key is not recommended

sessionToken?​

optional sessionToken?: string

Defined in: aws/src/deployers/awsdeployer.ts:66

AWS_SESSION_TOKEN Token

Even if it is possible to add it here It is not sustainable as this token at its best will have a lifetime of 12 hours

Tags?​

optional Tags?: TagsDefinition

Defined in: aws/src/deployers/awsdeployer.ts:85

Default Tags to use with resources created by deployers

type​

type: string

Defined in: core/lib/services/serviceparameters.d.ts:8

Type of the service

Inherited from​

ServiceParameters.type

Methods​

load()​

load(params?): this

Defined in: core/lib/services/serviceparameters.d.ts:18

Load raw parameters by assigning them onto this instance

Parameters​

params?​

any

the service parameters

Returns​

this

this for chaining

Inherited from​

ServiceParameters.load

update()​

update(params, delta): this

Defined in: core/lib/services/serviceparameters.d.ts:25

Update parameters and call watchers if a parameter was changed

Parameters​

params​

any

the service parameters

delta​

any

the delta

Returns​

this

this for chaining

Inherited from​

ServiceParameters.update

with()​

with(callback): this

Defined in: core/lib/services/serviceparameters.d.ts:31

Watch for changes on the parameters and call watchers when a parameter is changed

Parameters​

callback​

(params) => void

the callback function

Returns​

this

this for chaining

Inherited from​

ServiceParameters.with