AWS

Defines the settings for AWS core settings, including IAM roles and account permissions.

Type: aws-configuration

Properties

Name	Type	Description	Required
iam (IAM Configuration)	object		no
account	object		yes
networking	object		no

Additional Properties: not allowed
Example

{
    "iam": {
        "scope_workflow_role": "arn:aws:iam::123456789012:role/scope-workflow-role",
        "scope_workflow_intermediate_role": "arn:aws:iam::123456789012:role/scope-workflow-intermediate-role"
    },
    "account": {
        "id": "123456789012",
        "region": "us-east-1"
    },
    "networking": {
        "domain_name": "example.com",
        "hosted_zone_id": "Z1236544LJ11DEI6J5UW",
        "application_domain": false,
        "hosted_public_zone_id": "Z0123451R02R84JD4U98"
    }
}

iam: IAM Configuration

Properties

Name	Type	Description	Required
scope_workflow_role	string	IAM role ARN used to perform actions over client cloud resources Pattern: ^arn:aws:iam::[0-9]{12}:role/[a-zA-Z0-9+=,.@_-]+$	no
scope_workflow_intermediate_role	string	IAM role ARN that is intermediately assumed during workflow execution Pattern: ^arn:aws:iam::[0-9]{12}:role/[a-zA-Z0-9+=,.@_-]+$	no

Example

{
    "scope_workflow_role": "arn:aws:iam::123456789012:role/scope-workflow-role",
    "scope_workflow_intermediate_role": "arn:aws:iam::123456789012:role/scope-workflow-intermediate-role"
}

account: Account

Properties

Name	Type	Description	Required
id (Account ID)	string	A 12-digit number uniquely identifying your AWS account (e.g., '123456789012') Minimal Length: 12 Maximal Length: 12 Pattern: ^[0-9]{12}$	yes
region	string	The primary AWS region where your resources are deployed (e.g., 'us-east-1') Enum: "us-east-1", "us-east-2", "us-west-1", "us-west-2", "eu-west-1", "eu-west-2", "eu-west-3", "eu-central-1", "eu-north-1", "ap-southeast-1", "ap-southeast-2", "ap-northeast-1", "ap-northeast-2", "ap-south-1", "sa-east-1", "ca-central-1", "me-south-1", "af-south-1"	yes

Example

{
    "id": "123456789012",
    "region": "us-east-1"
}

networking: Networking

Properties

Name	Type	Description	Required
domain_name	string	The domain name to be used for when creating DNS resources
hosted_zone_id	string	The Route53 private hosted zone ID Pattern: ^Z[A-Z0-9]{10,}$
application_domain	boolean	Use account name as part of applications domains Default: false
hosted_public_zone_id	string	The Route53 public hosted zone ID Pattern: ^Z[A-Z0-9]{10,}$

Example

{
    "domain_name": "example.com",
    "hosted_zone_id": "Z1236544LJ11DEI6J5UW",
    "application_domain": false,
    "hosted_public_zone_id": "Z0123451R02R84JD4U98"
}