Interface AttiniRunnerProps

interface AttiniRunnerProps {
    awsVpcConfiguration?: AwsVpcConfiguration;
    containerName?: string;
    ec2Configuration?: Ec2Configuration;
    ecsCluster?: string;
    image?: string;
    roleArn?: string;
    runnerConfiguration?: RunnerConfiguration;
    startup?: Startup;
    taskDefinitionArn?: string;
}

Properties

awsVpcConfiguration? containerName? ec2Configuration? ecsCluster? image? roleArn? runnerConfiguration? startup? taskDefinitionArn?

Properties

Optional Readonly awsVpcConfiguration

awsVpcConfiguration?: AwsVpcConfiguration

VPC configuration.

Optional Readonly containerName

containerName?: string

The name of the container in the task definition. This is only required if a task definition with multiple containers is specified.

Optional Readonly ec2Configuration

ec2Configuration?: Ec2Configuration

Configures an EC2 instance to host the Runner ECS task. By default, Attini Runners use Fargate, but you can use EC2 instead. This is useful if you want to start a container from the ECS container, which is currently not possible with Fargate.

Optional Readonly ecsCluster

ecsCluster?: string

The name of the ECS Cluster to use. This is not mandatory if there is a default cluster in the account.

Optional Readonly image

image?: string

A Container image that the runner should use. If you configure this value, Attini will configure a TaskDefinition for you.

This configuration can not be combined with the taskDefinitionArn configuration.

Optional Readonly roleArn

roleArn?: string

The IAM Role the Runner should use.

This IAM Role will override the IAM Role from the TaskDefinition.

This IAM Role requires a basic execution policy that allows the runner to communicate with the deployment plan. Add the following execution policy to the IAM Role:

arn:aws:iam::${AccountId}:policy/attini-runner-basic-execution-policy-${Region}

Optional Readonly runnerConfiguration

runnerConfiguration?: RunnerConfiguration

Configuration for the runner.

Optional Readonly startup

startup?: Startup

Runner startup configuration.

Optional Readonly taskDefinitionArn

taskDefinitionArn?: string

Fargate ECS task definition that the Attini Runner should use.

If omitted, then Attini will use its default task definition.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc