Constructor
new CloudFormation(stackName)
Create a new CloudFormation stack
Parameters:
| Name | Type | Description |
|---|---|---|
stackName |
string | the basic name of the stack. The name should be sinple PascalCase string, without environment variations such as "dev" |
- Source:
Members
persistComponentProtection
Switch on/off persist component protection. If on and if there are data-lose changes on
data-persist components such as S3, Cognito user pool, DynamoDB, an error will be thrown.
- Source:
Methods
createApiGateway(baseName) → {ApiGateway}
Create a API Gateway object
Parameters:
| Name | Type | Description |
|---|---|---|
baseName |
string |
- Source:
Returns:
- Type
- ApiGateway
createCognitoBuiltinUser(baseName, userPool) → {CognitoBuiltinUser}
Create a new user in the user pool.
Parameters:
| Name | Type | Description |
|---|---|---|
baseName |
string | |
userPool |
CognitoUserPool |
- Source:
Returns:
- Type
- CognitoBuiltinUser
createCognitoIdentityPool(baseName) → {CognitoIdentityPool}
Create a Cognito Identity pool object
Parameters:
| Name | Type | Description |
|---|---|---|
baseName |
string |
- Source:
Returns:
- Type
- CognitoIdentityPool
createCognitoUserGroup(baseName, userPool) → {CognitoUserGroup}
Create a Cognito user group.
Parameters:
| Name | Type | Description |
|---|---|---|
baseName |
string | |
userPool |
CognitioUserPool |
- Source:
Returns:
- Type
- CognitoUserGroup
createCognitoUserPool(baseName) → {CognitioUserPool}
Create Cognito User Pool
Parameters:
| Name | Type | Description |
|---|---|---|
baseName |
string |
- Source:
Returns:
- Type
- CognitioUserPool
createCognitoUserPoolAppClient(baseName, userPool) → {CognitoUserPoolAppClient}
Create a Coginito User Pool app client. Must have a CognitoUserPool instance.
Parameters:
| Name | Type | Description |
|---|---|---|
baseName |
string | |
userPool |
CognitoUserPool |
- Source:
Returns:
- Type
- CognitoUserPoolAppClient
createDynamoDbTable(baseName) → {DynamoDbTable}
Create a DynamoDB table
Parameters:
| Name | Type | Description |
|---|---|---|
baseName |
string |
- Source:
Returns:
- Type
- DynamoDbTable
createGenericComponent(baseName) → {GenericComponent}
Create a generic AWS component. Use this if the AWS component you want to use
is not yet directly supported by Cloudatlas.
Parameters:
| Name | Type | Description |
|---|---|---|
baseName |
string |
- Source:
Returns:
- Type
- GenericComponent
createLambda(lambdaName) → {Lambda}
Create a Lambda object (AWS::Lambda::Function)
Parameters:
| Name | Type | Description |
|---|---|---|
lambdaName |
string |
- Source:
Returns:
- Type
- Lambda
createPolicy(baseName) → {Policy}
Create a Policy object (AWS::IAM::Policy)
Parameters:
| Name | Type | Description |
|---|---|---|
baseName |
string |
- Source:
Returns:
- Type
- Policy
createRole(roleName) → {Role}
Create a Role object (AWS::IAM::Role)
Parameters:
| Name | Type | Description |
|---|---|---|
roleName |
string |
- Source:
Returns:
- Type
- Role
createS3Bucket(baseName) → {S3}
Create a S3 bucket
Parameters:
| Name | Type | Description |
|---|---|---|
baseName |
string |
- Source:
Returns:
- Type
- S3
getComponent()
Get the component with specified class and base name
- Source: