Skip to main content
logoTetrate Service BridgeVersion: 1.10.x

AWS Identity

AwsIdentity represents an AWS-specific identity of a workload.

E.g.,

  • AWS EC2 instance identity:

    partition: aws
    account: '123456789012'
    region: ca-central-1
    zone: ca-central-1b
    ec2:
    instance_id: i-1234567890abcdef0
    iam_role:
    name: example-role
  • AWS ECS task identity:

    partition: aws
    account: '123456789012'
    region: ca-central-1
    zone: ca-central-1b
    ecs:
    task_id: 16aeded318d842bb8226e5bc678cd446
    cluster: bookinfo
    iam_role:
    name: example-role

AwsIdentity

AwsIdentity represents an AWS-specific identity of a workload.

FieldDescriptionValidation Rule

partition

string
REQUIRED
AWS Partition.

E.g., aws, aws-cn, aws-us-gov, etc.

See https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html

string = {
  min_len: 1
}

account

string
REQUIRED
AWS Account.

E.g., 123456789012.

See https://docs.aws.amazon.com/general/latest/gr/acct-identifiers.html

string = {
  pattern: ^[0-9]{12}$
}

region

string
REQUIRED
AWS Region.

E.g., us-east-2, eu-west-3, cn-north-1, etc.

See https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints

string = {
  min_len: 1
}

zone

string
REQUIRED
AWS Availability Zone.

E.g., us-east-2a, eu-west-3b, ap-southeast-1c, etc.

See https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html

string = {
  min_len: 1
}

ec2

tetrateio.api.onboarding.config.types.identity.aws.v1alpha1.Ec2Instance oneof _kind
AWS EC2 instance.

Ec2Instance

Ec2Instance represents AWS EC2 instance.

FieldDescriptionValidation Rule

instanceId

string
REQUIRED
EC2 instance ID.

E.g., i-1234567890abcdef0.

See https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-instances.html

string = {
  min_len: 1
}

iamRole

tetrateio.api.onboarding.config.types.identity.aws.v1alpha1.IamRole
AWS IAM Role associated with the AWS EC2 instance.

See https://docs.aws.amazon.com/cli/latest/reference/iam/add-role-to-instance-profile.html

IamRole

IamRole represents AWS IAM Role.

FieldDescriptionValidation Rule

name

string
REQUIRED
Role name.

E.g., example-role.

See https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html

string = {
  min_len: 1
}