Type: String

Only supported value is Distribution

Required: Yes

Type: source

The distribution name that you want to import the value from.

Required: Yes

Type: String

An image URI which will be used to fetch a container for packaging your distribution.

Useful if you, for example, want to build your distribution locally inside a container that mimics your build server.

Required: No

Type: List<String>

List of shell commands that will be executed before the docker run command when using container builds.

Should only be used to log in to the image repository if the image needs to be downloaded as they are executed before the container is started.

Required: No

Type: List<String>

Command-line options you want to add the docker run command the Attini CLI generates and run for you.

Useful if you need to configure anything specific for your build container, for example, if you need to transfer AWS credentials to the container (-v $HOME/.aws:/root/.aws:rw).

Required: No

Type: List<String>

List of shell commands that is executed after the final distribution is created.

Useful if you, for example, want to move the distribution somewhere after the packaging is done.

Required: No

Type: List<String> List of shell commands that are executed before distribution is created.

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

Useful if you, for example, want to configure the distribution (see attini configure command) or fetch external resources to be included in the distribution.

Required: Yes

Type: String

The step that the deployment plan should start with. This is the same as the StartAt property in the Amazon States Language

Required: Yes

Type: Map<Sting,Map>

This is the same as the States property in the Amazon States Language after the Attini-specific resources (ex AttiniCfn) have been converted into a valid Amazon States Language definition.

Make sure that the actions that you specify here are allowed by the deployment plan Role.

This map has limited support for CloudFormation functions.

• Simple functions like Ref, Fn::GetAtt and Fn::Sub work like normal CloudFormation.
• Complex functions like Fn::Join will need to use the DefinitionSubstitutions property.
• Conditions are not supported. You can often work around this limitation using logic in your definition, example by using the Choice state.

Required: Yes

Type: String

Any valid State type like Attini types, StateMachine Task, or other StateMachine States like Pass, Wait, Succeed, Fail, Choice or Parallel.

Type: String

Name of the next step.

Required: Yes, if End is not configured

Type: Boolean

Marks the end of a branch execution.

Required: Yes, if End is not configured

Type: String

Name of the State. This has to be unique within the deployment plan.

Type: String

Any valid State type like Attini type, StateMachine Task, or other StateMachine States like Pass, Wait, Succeed and Fail.

Parallel and Choice are supported but have their own simplified syntax.

Type: Comparison

This Comparison is a direct translation for Amazon state language choice but without “Next”.

Required: Yes

Type: List<State>

A List of States that will be executed if the Condition is true.

Required: Yes

Type: List<State>

A List of States that will be executed if the Condition is false.

If IsFalse is omitted, the deployment will continue to the next step if the Condition is false (or end if it is the last step).

Required: No

Type: String

The distribution name.

Type: String

The time in epoch milliseconds that the Attini distribution was deployed to this environment.

Type: deploymentSource

A Map containing data needed to find artifacts related to this deployment.

Type: String

The current environment.

Type: String

The distribution id.

Type: String

The S3 key for the S3 object key and version (distribution) that triggered the deployment.

Type: String

The name of the Init Deploy CloudFormation stack name.

Type: Map<String,String>

The distribution tags from attini-config.

Type: String

The distribution semantic version.

Type: Boolean

If this is true, Attini has done a SAM Package due to a AttiniSam step in the deployment plan.

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

Type: String,String

A comma-separated list of the subnets’ ids associated with the ECS task. For more information, see the AWS ECS VPC documentation

Required: Yes

Default: default VPC subnets

Type: String,String

A comma-separated list of the security group ids associated with the ECS task. For more information see the AWS ECS VPC documentation

Required: No

Default: String,String

Type: String

For more information, see the AWS ECS VPC documentation.

Required: No

Allowed Values: ENABLED | DISABLED

Default: ENABLED

Type: String

The Ami (Amazon Machine Image) has to be a valid AMI ID or one of the following values:

• AmazonLinux2
• AmazonLinux2_arm64
• AmazonLinux2_gpu
• AmazonLinux2_inf
• AmazonLinux2023
• AmazonLinux2023_arm64
• AmazonLinux2023_inf

Attini will use a corresponding recommended AMI fetched from AWS SSM Parameter store to get the correct AMI ID for your region.

If you configure your own AMI ID, it needs the ECS agent installed and enabled.

Required: No

Default: AmazonLinux2

Type: String

AWS Instance type, for example m5.large.

Required: Yes

Type: String

Using an instance profile name, you can give your EC2 custom IAM Access.

Required: No

Default: `attini-runner-default-instance-profile-{Region} (created by attini-setup)

Type: Number

The max number of concurrent jobs the Attini Runner will execute.

Required: No

Default: 5

Allowed Range: 1-20

Type: Number

The number of seconds the Attini Runner will stay alive without any jobs executing. New jobs will reset the countdown.

Required: No

Default: 3600

Allowed Range: 60-86400

Type: Number

The number of seconds a job can execute before the Attini Runner aborts the execution.

Required: No

Default: 3600

Allowed Range: 5-172800

Type: String

The log level of the Attini Runner.

Required: No

Default: INFO

Allowed Values: DEBUG | INFO | WARN | ERROR | OFF | ALL

Type: List<String>

List of shell commands that runs when the Attini Runner starts.

Required: No

Default: None

Type: Number

The number of seconds the startup commands can be executed before the Attini Runner aborts the execution.

Required: No

Default: 3600

Allowed Range: 5-172800