Type: String

Reference a Attini::Deploy::Runner recourse, find more information here.

Required: No

Type: String

Location of your CDK project directory inside your Attini distribution.

Required: Yes

Type: String

This property is passed to the --app option in the CDK CLI.

If your project has a cdk.json file with the "app" property configured, this is not needed.

Required: No

Type: Diff

Required: No

Type: Map<String,String>

This property lets you set environment variables on the container that will deploy the CDK project. This way, the CDK project can get data from the deployment plan payload.

Your code can access these environment variables directly, via the Context configuration, or the StackConfiguration (parameters).

Example

Type: AttiniCdk
Properties:
    Path: my-app
    Environment:
      ENV.$: $.environment
      VPC_ID.$: $.output.vpc.id

Required: No

Type: List<String>

The Stacks in your CDK project to deploy. If omitted, the --all option in the CDK CLI will be used.

Required: No

Default: All

Type: Map<String,String>

This property is passed to the --context option in the CDK CLI.

Example

Type: AttiniCdk
Properties:
    Path: my-app
    Context:
      vpd_id: $.output.vpc.id

Required: No

Type: List<String>

This property is passed to the --plugin option in the CDK CLI.

Required: No

Type: List<CdkParameters>

This property is passed to the --parameters option in the CDK CLI.

Required: No

Type: String

This property is passed to the --build option in the CDK CLI.

Example

Type: AttiniCdk
Properties:
    Path: my-app
    Build: |
      echo "My build commands"
      npm install      

Required: No

Type: List<String>

This property is passed to the --build-exclude option in the CDK CLI.

Required: No

Type: List<String>

This property is passed to the --notification-arns option in the CDK CLI.

Required: No

Type: Boolean

This property is passed to the --force option in the CDK CLI.

Required: No

Type: String

This property is passed to the --role-arn option in the CDK CLI.

Required: No

Type: String

The path to the CloudFormation template. Can either be:

1. A path to a file in the distribution.
2. A URL to a public S3 file, starting with https://.
3. An S3 path, starting with s3://.

Required: Yes (can be configured in the ConfigFile)

Type: String

AWS API compatibility: This property is passed directly to the StackName property of the CreateStack or UpdateStack API call.

Required: Yes (can be configured in the ConfigFile)

Type: String

This is a reference to a JSON or a YAML file in the distribution.

Find more info in the CloudFormation configuration documentation

Required: No

Type: Map<String, String>

The CloudFormation parameters, find more info in the CloudFormation configuration documentation

Required: No (can be configured in the ConfigFile)

Type: Map<String,String>

The CloudFormation stack tags.

Required: No (can be configured in the ConfigFile)

Type: String

Arn of the StackRole, find more info here: AWS CloudFormation service role

Find more information about the security aspects of StackRoles here

Required: Conditional (can be configured in the ConfigFile)

Type: String

The role that you want to be assumed when the Attini Framework deploys the CloudFormation stack. This can be useful if you are:

• Applying the least privilege policies without using Stack roles
• Doing cross-account deployments

The ExecutionRole has to trust the attini action default role arn:aws:iam::{AccountId}:role/attini/attini-action-role-{Region} so that it can be assumed.

Example trust relationship policy:

{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Effect": "Allow",
      "Principal": {
        "AWS": [
          "arn:aws:iam::111111111111:role/attini/attini-action-role-eu-west-1"
        ]
      },
      "Action": "sts:AssumeRole"
    }
  ]
}

Find more information about the security aspects of ExecutionRoles here.

Required: No (can be configured in the ConfigFile)

Default: arn:aws:iam::{AccountId}:role/attini/attini-action-role-{Region}

Type: String

Configure the region you want the CloudFormation stack in.

Required: No

Default: Current region

Type: String

If you need an extra level of separation for your payload output, you can use OutputPath. This is useful if you need to have multiple output sections from one step, example when you use AttiniMap.

If you, for example, have a State name buzz and an OutputPath: foo the output payload will look like this:

{
  "output": {
    "buzz": {
      "foo": {
        "OutputKey": "OutputValue"
      }
    }
  }
}

Required: No (can be configured in the ConfigFile)

Type: Map<String,String>

If your step has a ConfigFile configured, you can use Variables to pass values from your deployment plan payload into the file.

If you, for example, have an AttiniCfn State with the following config:

StateName:
  Type: AttiniCfn
  Properties:
    Template: /ecs-service.yaml
    ConfigFile: /ecs-config.yaml
    Variables:
      Environment: !Ref AttiniEnvironmentName
      DatabasePort.$: $.output.Database.Port
      StackRoleArn.$: $.output.StackRoles.EcsStackRole
    StackName: ecs-service

Your ConfigFile can look like this:

stackRoleArn: ${StackRoleArn}
parameters:
  ServiceName: ${Environment}-my-ecs-service
  DatabasePort: ${DatabasePort}

Required: No (can be configured in the ConfigFile)

Type: String

Specify if the stack should be deployed (created/updated), or deleted.

Allowed values: Deploy | Delete

Required: No (can be configured in the ConfigFile)

Default: Deploy

Type: String

Specifies what kind of source should be used.

Allowed values: Distribution | S3

Required: Yes

Type: S3Source | DistributionSource

Different sources require different information in order to import them. For example, S3 needs a bucket and key while a distribution needs the name of the distribution.

Which Source you need is decided by the SourceType.

Required: Yes

Type: Map<String,String>

A key/value map where the value is a path to a value in the imported document. The path follows the JSONPath syntax. The value on the path will be included in the output of the step under the same key name as the mapping.

For example the following JSON source:

{
  "my-service-endpoint": "https://some-endpoint.com"
}

With the following mapping:

endpoint: $.my-service-endpoint

Would produce the following output for the step in the deployment plan payload.

{
  "endpoint": "https://some-endpoint.com"
}

Required: Yes

Type: String

The arn of the execution role that should be used for accessing the source. At the moment only needed for the S3 source type if Attini does not have access to the S3 Bucket.

Required: No

Default: None

Type: String

Lambda function name.

Required: Yes

Type: Map<String,String

This is passed directly to the Payload configuration in the Step Functions, and it works the same way.

By default, the entire deployment plan payload will be passed as input to the Lambda function.

Required: No

Type: String

Reference a Attini::Deploy::Runner recourse, find more information here.

Default: Attini default runner

Required: No

Type: Map<String,String>

This property lets you set environment variables on the Runner.

Example

Type: AttiniRunnerJob
Properties:
  Environment:
    ENV.$: $.environment
    VPC_ID.$: $.output.vpc.id
  Commands:
    - echo ${VPC_ID}

Required: No

List of shell commands that runs the job.

These commands are run with set -eo pipefail configuration so that they fail quickly. To revert this configuration (and ignore errors in your scrips), begin your commands with the line: set +eo pipefail.

Required: Yes

Type: SamProject

Required: Yes