# AwsAccount

One AWS account the AwsConnection reaches, keyed on its account id within the tenant (two tenants may connect the same account).

One AWS account the AwsConnection reaches, keyed on its account id within the tenant (two tenants may connect the same account). It takes the connection's connector kind. Deploying puts the Vulnesis pipeline stack in the account through the connection; the per-account advancedNetworking column is written only from AwsConnection.spec.advancedNetworking today. Deleting the document turns the account off rather than forgetting it, because the deployed stack outlives the row and has to stay findable.

| | |
|---|---|
| `apiVersion` | `vulnetix.com/v1` |
| `kind` | `AwsAccount` |
| Group | [Cloud](/platform-iac/kinds/catalogue.md#cloud) |
| Status | **Served.** The [config engine](/platform-iac/reference/engine.md) plans and applies it. |
| Objects per tenant | many, keyed by `metadata.name` |
| Token and role | An owner, or a service account with the developer role (its ApiKey), or an Authentik access token for either. A member is refused with HTTP 403. See [Credentials for automation](/platform-iac/reference/config-api.md#credentials-for-automation). |
| Applied after | [`AwsConnection`](/platform-iac/kinds/aws-connection.md) (deleted before them) |
| Terraform resource | [`vulnetix_aws_account`](/platform-iac/terraform/resources.md#vulnetix_aws_account), imported by name (see [Terraform and OpenTofu](#terraform-and-opentofu)) |
| CLI | [`vulnetix config apply`](/platform-iac/cli/apply.md), CLI v3.165.1 and later. |
| Pinned schema | [`v1.19.1/AwsAccount.schema.json`](https://github.com/Vulnesis/config-schemas/releases/download/v1.19.1/AwsAccount.schema.json) |
| Newest schema | [`latest/AwsAccount.schema.json`](https://github.com/Vulnesis/config-schemas/releases/latest/download/AwsAccount.schema.json) |
| First released in | [`v1.3.0`](https://github.com/Vulnesis/config-schemas/releases/tag/v1.3.0) |
| Print the built-in copy | `vulnetix config schema AwsAccount` |

## Minimal

Only the fields the kind requires. From `examples/AwsAccount/minimal.yaml`.

**YAML**

```yaml
# yaml-language-server: $schema=https://github.com/Vulnesis/config-schemas/releases/latest/download/AwsAccount.schema.json
apiVersion: vulnetix.com/v1
kind: AwsAccount
metadata:
  name: production
spec:
  accountId: "123456789012"
```

**HCL** (resource `vulnetix_aws_account`)

```hcl
# Only the arguments the kind requires. From config-schemas examples/AwsAccount/minimal.yaml.

resource "vulnetix_aws_account" "production" {
  name       = "production"
  account_id = "123456789012"
}
```

Every field that has a schema default, set to that default: [`terraform/aws_account.tf`](https://github.com/Vulnesis/platform-iac-examples/blob/main/terraform/aws_account.tf) and [`yaml/AwsAccount.yaml`](https://github.com/Vulnesis/platform-iac-examples/blob/main/yaml/AwsAccount.yaml) in [Vulnesis/platform-iac-examples](https://github.com/Vulnesis/platform-iac-examples).

**CLI** (applies it)

```bash
export VULNESIS_ORG_ID=...    # the organization UUID
export VULNESIS_API_KEY=...   # the ApiKey of a developer or owner service account
vulnetix config apply -f - --manager gitops:acme/platform --auto-approve <<'EOF'
# yaml-language-server: $schema=https://github.com/Vulnesis/config-schemas/releases/latest/download/AwsAccount.schema.json
apiVersion: vulnetix.com/v1
kind: AwsAccount
metadata:
  name: production
spec:
  accountId: "123456789012"
EOF
```

## Advanced

Every field the kind supports, with a `when` expression where it takes one. From `examples/AwsAccount/advanced.yaml`.

**YAML**

```yaml
# yaml-language-server: $schema=https://github.com/Vulnesis/config-schemas/releases/latest/download/AwsAccount.schema.json
apiVersion: vulnetix.com/v1
kind: AwsAccount
metadata:
  name: production
  labels:
    environment: production
  annotations:
    owner: platform-team@example.com
spec:
  accountId: "123456789012"
  accountName: acme-production
  roleName: AdministratorAccess
  enabled: true
  deploy: true
```

**HCL** (resource `vulnetix_aws_account`)

```hcl
# Every argument the kind supports. From config-schemas examples/AwsAccount/advanced.yaml.

resource "vulnetix_aws_account" "production" {
  name         = "production"
  account_id   = "123456789012"
  account_name = "acme-production"
  deploy       = true
  enabled      = true
  role_name    = "AdministratorAccess"
  labels = {
    environment = "production"
  }
  annotations = {
    owner = "platform-team@example.com"
  }
}
```

Every field that has a schema default, set to that default: [`terraform/aws_account.tf`](https://github.com/Vulnesis/platform-iac-examples/blob/main/terraform/aws_account.tf) and [`yaml/AwsAccount.yaml`](https://github.com/Vulnesis/platform-iac-examples/blob/main/yaml/AwsAccount.yaml) in [Vulnesis/platform-iac-examples](https://github.com/Vulnesis/platform-iac-examples).

**CLI** (applies it)

```bash
export VULNESIS_ORG_ID=...    # the organization UUID
export VULNESIS_API_KEY=...   # the ApiKey of a developer or owner service account
vulnetix config apply -f - --manager gitops:acme/platform --auto-approve <<'EOF'
# yaml-language-server: $schema=https://github.com/Vulnesis/config-schemas/releases/latest/download/AwsAccount.schema.json
apiVersion: vulnetix.com/v1
kind: AwsAccount
metadata:
  name: production
  labels:
    environment: production
  annotations:
    owner: platform-team@example.com
spec:
  accountId: "123456789012"
  accountName: acme-production
  roleName: AdministratorAccess
  enabled: true
  deploy: true
EOF
```

## Fields

Paths use dots for nesting and `[]` for the items of a list. **Required** means required whenever the parent object is present. A default is what the server uses when the field is left out.

| Field | Type | Required | Default | Allowed values | Description |
|---|---|---|---|---|---|
| <span id="apiVersion"></span>`apiVersion` | string | yes |  | exactly `vulnetix.com/v1` | The document format version. Every kind in this release is vulnetix.com/v1. |
| <span id="kind"></span>`kind` | string | yes |  | exactly `AwsAccount` | Always AwsAccount. |
| <span id="metadata"></span>`metadata` | object | yes |  | no other keys |  |
| <span id="metadata-name"></span>`metadata.name` | string | yes |  | pattern `^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$` | The object's name, unique per kind within a tenant. It is the natural key: plan, apply, export and the Terraform provider all address an object by kind and name. |
| <span id="metadata-org"></span>`metadata.org` | string | no |  | format `uuid` | The tenant (organization UUID) the document belongs to. When set, plan and apply refuse to run against any other tenant. |
| <span id="metadata-labels"></span>`metadata.labels` | object | no |  | map of string to string (length 0 to 256); keys match `^[a-z0-9]([a-z0-9._/-]{0,61}[a-z0-9])?$` | Free key/value labels. Stored with the object, never interpreted by the server. |
| <span id="metadata-annotations"></span>`metadata.annotations` | object | no |  | map of string to string (length 0 to 4096) | Free key/value notes for people and tools, such as a ticket link. |
| <span id="spec"></span>`spec` | object | yes |  | no other keys |  |
| <span id="spec-accountId"></span>`spec.accountId` | string | yes |  | pattern `^[0-9]{12}$` | A 12-digit AWS account id. |
| <span id="spec-accountName"></span>`spec.accountName` | string | no |  | length 1 to 256 | A display name. AWS's own alias replaces it when the account is read; nothing keys on it. |
| <span id="spec-roleName"></span>`spec.roleName` | string | no |  | pattern `^[\w+=,.@-]{1,64}$` | For sso: the permission set the CloudFormation deploy runs as. |
| <span id="spec-enabled"></span>`spec.enabled` | boolean | no | `true` |  | Whether the account is swept. false leaves the other accounts and the deployed stack alone. |
| <span id="spec-deploy"></span>`spec.deploy` | boolean | no | `false` |  | Queue a deploy of the pipeline stack when apply creates the account or changes it. A deploy already running is not queued twice. sso deploys need a live Identity Center session. |

## Applying this kind

- **Command.** `vulnetix config apply -f <file>`; the CLI line above says from which release. Plan first with [`vulnetix config plan`](/platform-iac/cli/plan.md): it shows each object as create, update, delete or no change, with a `planHash` that apply then holds to. Apply writes in one transaction.
- **Manager.** Each object records the manager that applied it (`terraform`, `console` or `gitops:<repo>`). `--prune` deletes only objects its own manager owns. See [The manager](/platform-iac/cli/plan.md#the-manager) and the [config engine](/platform-iac/reference/engine.md).
- **Order.** Applied after [`AwsConnection`](/platform-iac/kinds/aws-connection.md), so a document that refers to one by `metadata.name` can be in the same apply. Deleted before them.
- **Status.** `stackStatus`, the account's CloudFormation deploy. The phases the engine reports are explained under [status phases](/platform-iac/reference/engine.md#status-phases).

## How apply treats it

- Names live in `ConfigManagedObject`. An account nobody declared exports as `aws-<id>-<hash>`.
- `accountId` cannot change under a name, and one account has one name.
- `accountName` is compared only while the account has none, because AWS's alias replaces it.
- `deploy: true` queues the account's stacks when apply creates or changes it. It is never read back.
- Delete stops the sweep and warns that the stacks and findings stay.

## Terraform and OpenTofu

The resource is `vulnetix_aws_account` in the `vulnetix/resolve` provider. Its arguments are the `spec` in snake case, beside `name`, `labels` and `annotations` from `metadata`. The Minimal and Advanced HCL are above. The provider's own reference is [vulnetix_aws_account](https://registry.terraform.io/providers/vulnetix/resolve/latest/docs/resources/aws_account).

Import an object that already exists by its name:

```shell
# Import an existing AwsAccount by its name (metadata.name).
terraform import vulnetix_aws_account.production production
```

Install, authentication and how state is read: [Terraform and OpenTofu](/platform-iac/terraform.md).

## More examples

`examples/AwsAccount/accounts.yaml` from `Vulnesis/config-schemas`:

```yaml
# yaml-language-server: $schema=https://github.com/Vulnesis/config-schemas/releases/latest/download/AwsAccount.schema.json
apiVersion: vulnetix.com/v1
kind: AwsAccount
metadata:
  name: production
spec:
  accountId: "123456789012"
  accountName: acme-production
  roleName: AdministratorAccess
  deploy: true
---
apiVersion: vulnetix.com/v1
kind: AwsAccount
metadata:
  name: sandpit
spec:
  accountId: "210987654321"
  roleName: VulnetixCloudscanDeploy
  enabled: false
```

Check a file with `vulnetix config validate -f <file>`. See [Validate documents](/platform-iac/cli/validate.md). In an editor, start the file with the [schema comment](/platform-iac/schemas/editors.md).
