InstanceProfile

iam.services.k8s.aws/v1alpha1

TypeLink
GoDociam-controller/apis/v1alpha1#InstanceProfile

Metadata

PropertyValue
ScopeNamespaced
KindInstanceProfile
ListKindInstanceProfileList
Pluralinstanceprofiles
Singularinstanceprofile

Contains information about an instance profile.

This data type is used as a response element in the following operations:

  • CreateInstanceProfile

  • GetInstanceProfile

  • ListInstanceProfiles

  • ListInstanceProfilesForRole

Spec

name: string
path: string
role: string
roleRef: 
  from: 
    name: string
    namespace: string
tags:
- key: string
  value: string
FieldDescription
name
Required
string
The name of the instance profile to create.

This parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex))
a string of characters consisting of upper and lowercase alphanumeric characters
with no spaces. You can also include any of the following characters: _+=,.@-
path
Optional
string
The path to the instance profile. For more information about paths, see IAM
Identifiers (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html)
in the IAM User Guide.

This parameter is optional. If it is not included, it defaults to a slash
(/).

This parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex))
a string of characters consisting of either a forward slash (/) by itself
or a string that must begin and end with forward slashes. In addition, it
can contain any ASCII character from the ! (\u0021) through the DEL character
(\u007F), including most punctuation characters, digits, and upper and lowercased
letters.
role
Optional
string
roleRef
Optional
object
AWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference
type to provide more user friendly syntax for references using ‘from’ field
Ex:
APIIDRef:

from:
name: my-api
roleRef.from
Optional
object
AWSResourceReference provides all the values necessary to reference another
k8s resource for finding the identifier(Id/ARN/Name)
roleRef.from.name
Optional
string
roleRef.from.namespace
Optional
string
tags
Optional
array
A list of tags that you want to attach to the newly created IAM instance
profile. Each tag consists of a key name and an associated value. For more
information about tagging, see Tagging IAM resources (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html)
in the IAM User Guide.

If any one of the tags is invalid or if you exceed the allowed maximum number
of tags, then the entire request fails and the resource is not created.
tags.[]
Required
object
A structure that represents user-provided metadata that can be associated
with an IAM resource. For more information about tagging, see Tagging IAM
resources (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html)
in the IAM User Guide.
tags.[].value
Optional
string

Status

ackResourceMetadata: 
  arn: string
  ownerAccountID: string
  region: string
conditions:
- lastTransitionTime: string
  message: string
  reason: string
  status: string
  type: string
createDate: string
instanceProfileID: 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.
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
createDate
Optional
string
The date when the instance profile was created.
instanceProfileID
Optional
string
The stable and unique string identifying the instance profile. For more information
about IDs, see IAM identifiers (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html)
in the IAM User Guide.