---
sidebar_label: AWS
doc_id: 4fe9b9b4-5598-4b7e-91a8-7f45d3aeab90
description: >-
  Configuration schema for AWS core settings including IAM roles, account
  details, and networking.
keywords:
  - AWS
  - IAM
  - configuration
  - networking
  - account settings
---

# AWS

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

**Type**: `aws-configuration`

**Properties**

|Name|Type|Description|Required|
|----|----|-----------|--------|
|[**iam**](#iam)<br/>(IAM Configuration)|`object`||no|
|[**account**](#account)|`object`||yes|
|[**networking**](#networking)|`object`||no|

**Additional Properties:** not allowed  
**Example**

```json
{
    "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"
    }
}
```

<a name="iam"></a>
## iam: IAM Configuration

**Properties**

|Name|Type|Description|Required|
|----|----|-----------|--------|
|**scope\_workflow\_role**|`string`|IAM role ARN used to perform actions over client cloud resources<br/>Pattern: `^arn:aws:iam::[0-9]{12}:role/[a-zA-Z0-9+=,.@_-]+$`<br/>|no|
|**scope\_workflow\_intermediate\_role**|`string`|IAM role ARN that is intermediately assumed during workflow execution<br/>Pattern: `^arn:aws:iam::[0-9]{12}:role/[a-zA-Z0-9+=,.@_-]+$`<br/>|no|

**Example**

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

<a name="account"></a>
## account: Account

**Properties**

|Name|Type|Description|Required|
|----|----|-----------|--------|
|**id**<br/>(Account ID)|`string`|A 12-digit number uniquely identifying your AWS account (e.g., '123456789012')<br/>Minimal Length: `12`<br/>Maximal Length: `12`<br/>Pattern: `^[0-9]{12}$`<br/>|yes|
|**region**|`string`|The primary AWS region where your resources are deployed (e.g., 'us-east-1')<br/>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"`, `"af-south-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"`, `"mx-central-1"`<br/>|yes|

**Example**

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

<a name="networking"></a>
## networking: Networking

**Properties**

|Name|Type|Description|Required|
|----|----|-----------|--------|
|**domain\_name**|`string`|The domain name to be used for when creating DNS resources<br/>||
|**hosted\_zone\_id**|`string`|The Route53 private hosted zone ID<br/>Pattern: `^Z[A-Z0-9]{10,}$`<br/>||
|**application\_domain**|`boolean`|Use account name as part of applications domains<br/>Default: `false`<br/>||
|**hosted\_public\_zone\_id**|`string`|The Route53 public hosted zone ID<br/>Pattern: `^Z[A-Z0-9]{10,}$`<br/>||

**Example**

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