OrganizationalUnit

organizations.services.k8s.aws/v1alpha1

TypeLink
GoDocorganizations-controller/apis/v1alpha1#OrganizationalUnit

Metadata

PropertyValue
ScopeNamespaced
KindOrganizationalUnit
ListKindOrganizationalUnitList
Pluralorganizationalunits
Singularorganizationalunit

Contains details about an organizational unit (OU). An OU is a container of Amazon Web Services accounts within a root of an organization. Policies that are attached to an OU apply to all accounts contained in that OU and in any child OUs.

Spec

name: string
parentID: string
tags:
- key: string
  value: string
FieldDescription
name
Required
string
The friendly name to assign to the new OU.
parentID
Required
string
The unique identifier (ID) of the parent root or OU that you want to create
the new OU in.


The regex pattern (http://wikipedia.org/wiki/regex) for a parent ID string
requires one of the following:


* Root - A string that begins with “r-” followed by from 4 to 32 lowercase
letters or digits.


* Organizational unit (OU) - A string that begins with “ou-” followed
by from 4 to 32 lowercase letters or digits (the ID of the root that the
OU is in). This string is followed by a second “-” dash and from 8 to
32 additional lowercase letters or digits.
tags
Optional
array
A list of tags that you want to attach to the newly created OU. For each
tag in the list, you must specify both a tag key and a value. You can set
the value to an empty string, but you can’t set it to null. For more information
about tagging, see Tagging Organizations resources (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_tagging.html)
in the Organizations User Guide.


If any one of the tags is invalid or if you exceed the allowed number of
tags for an OU, then the entire request fails and the OU is not created.
tags.[]
Required
object
A custom key-value pair associated with a resource within your organization.

You can attach tags to any of the following organization resources.

  • Amazon Web Services account

  • Organizational unit (OU)

  • Organization root

  • Policy || tags.[].key
    Optional | string
    | | tags.[].value
    Optional | string
    |

Status

ackResourceMetadata: 
  arn: string
  ownerAccountID: string
  region: string
conditions:
- lastTransitionTime: string
  message: string
  reason: string
  status: string
  type: string
id: string
FieldDescription
ackResourceMetadata
Optional
object
All CRs managed by ACK have a common Status.ACKResourceMetadata member
that is used to contain resource sync state, account ownership,
constructed ARN for the resource
ackResourceMetadata.arn
Optional
string
ARN is the Amazon Resource Name for the resource. This is a
globally-unique identifier and is set only by the ACK service controller
once the controller has orchestrated the creation of the resource OR
when it has verified that an “adopted” resource (a resource where the
ARN annotation was set by the Kubernetes user on the CR) exists and
matches the supplied CR’s Spec field values.
TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse
https://github.com/aws/aws-controllers-k8s/issues/270
ackResourceMetadata.ownerAccountID
Required
string
OwnerAccountID is the AWS Account ID of the account that owns the
backend AWS service API resource.
ackResourceMetadata.region
Required
string
Region is the AWS region in which the resource exists or will exist.
conditions
Optional
array
All CRS managed by ACK have a common Status.Conditions member that
contains a collection of ackv1alpha1.Condition objects that describe
the various terminal states of the CR and its backend AWS service API
resource
conditions.[]
Required
object
Condition is the common struct used by all CRDs managed by ACK service
controllers to indicate terminal states of the CR and its backend AWS
service API resource
conditions.[].message
Optional
string
A human readable message indicating details about the transition.
conditions.[].reason
Optional
string
The reason for the condition’s last transition.
conditions.[].status
Optional
string
Status of the condition, one of True, False, Unknown.
conditions.[].type
Optional
string
Type is the type of the Condition
id
Optional
string
The unique identifier (ID) associated with this OU.


The regex pattern (http://wikipedia.org/wiki/regex) for an organizational
unit ID string requires “ou-” followed by from 4 to 32 lowercase letters
or digits (the ID of the root that contains the OU). This string is followed
by a second “-” dash and from 8 to 32 additional lowercase letters or digits.