Resource Explorer

3 resource kinds. Generated from the operator's CRD schemas.

API Group: aws.konfig.io/v1alpha1

ResourceExplorer2DefaultViewAssociation # CLOUD CONTROL · AWS::ResourceExplorer2::DefaultViewAssociation ⚠ DESTRUCTIVE SCOPE

Caution, destructive scope: account-wide default view. Provided for completeness; do not use from application namespaces. Restrict with AWSProvider.allowedNamespaces and RBAC. ResourceExplorer2DefaultViewAssociation manages AWS::ResourceExplorer2::DefaultViewAssociation through the AWS Cloud Control API.

kubectl get resourceexplorer2defaultviewassociations · example on GitHub

Example

# ResourceExplorer2DefaultViewAssociation — Resource Explorer
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/resourceexplorer2.html#resourceexplorer2defaultviewassociation
apiVersion: aws.konfig.io/v1alpha1
kind: ResourceExplorer2DefaultViewAssociation
metadata:
  name: example-resourceexplorer2defaultviewassociation
  namespace: default
spec:
  providerRef:
    name: example-resourceexplorer2defaultviewassociation
    region: us-east-1
  viewArn: arn:aws:iam::123456789012:role/example-role

Spec

FieldTypeRequiredDescription
providerRefobject—ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
providerRef.namestringyesName of a cluster-scoped AWSProvider.
providerRef.regionstring—Region overrides the provider's region for this resource only.
viewArnstringyes

Status

FieldTypeRequiredDescription
associatedAwsPrincipalstring—The AWS principal that the default view is associated with, used as the unique identifier for this resource.
attemptinteger—Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
awsProviderobject—AWSProvider confirms the account and region this resource was reconciled against.
awsProvider.accountIdstring—AccountID the resource lives in.
awsProvider.namestring—Name of the AWSProvider used; empty when the operator's own credentials were used.
awsProvider.regionstring—Region the resource lives in (empty for global services).
conditionsarray<object>—Conditions describe the current state of the resource.
conditions[].lastTransitionTimestringyeslastTransitionTime is the last time the condition transitioned from one status to another.
conditions[].messagestringyesmessage is a human readable message indicating details about the transition.
conditions[].observedGenerationinteger—observedGeneration represents the .metadata.generation that the condition was set based upon.
conditions[].reasonstringyesreason contains a programmatic identifier indicating the reason for the condition's last transition.
conditions[].statusenumyesstatus of the condition, one of True, False, Unknown. Allowed: True, False, Unknown
conditions[].typestringyestype of condition in CamelCase or in foo.example.com/CamelCase.
identifierstring—Identifier is the Cloud Control primary identifier of the resource.
lastSyncTimestring—
observedGenerationinteger—
operationstring—Operation is the in-flight operation (CREATE, UPDATE, DELETE).
operationStatusstring—OperationStatus is the last reported operation status.
requestTokenstring—RequestToken tracks an in-flight asynchronous operation.

ResourceExplorer2Index # CLOUD CONTROL · AWS::ResourceExplorer2::Index

ResourceExplorer2Index manages AWS::ResourceExplorer2::Index through the AWS Cloud Control API.

kubectl get resourceexplorer2indices · example on GitHub

Example

# ResourceExplorer2Index — Resource Explorer
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/resourceexplorer2.html#resourceexplorer2index
apiVersion: aws.konfig.io/v1alpha1
kind: ResourceExplorer2Index
metadata:
  name: example-resourceexplorer2index
  namespace: default
spec:
  providerRef:
    name: example-resourceexplorer2index
    region: us-east-1
  tags:
    environment: dev
    team: platform
  type: LOCAL

Spec

FieldTypeRequiredDescription
providerRefobject—ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
providerRef.namestringyesName of a cluster-scoped AWSProvider.
providerRef.regionstring—Region overrides the provider's region for this resource only.
tagsmap<string>—
typeenumyesAllowed: LOCAL, AGGREGATOR

Status

FieldTypeRequiredDescription
arnstring—Read-only: reported by AWS after creation.
attemptinteger—Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
awsProviderobject—AWSProvider confirms the account and region this resource was reconciled against.
awsProvider.accountIdstring—AccountID the resource lives in.
awsProvider.namestring—Name of the AWSProvider used; empty when the operator's own credentials were used.
awsProvider.regionstring—Region the resource lives in (empty for global services).
conditionsarray<object>—Conditions describe the current state of the resource.
conditions[].lastTransitionTimestringyeslastTransitionTime is the last time the condition transitioned from one status to another.
conditions[].messagestringyesmessage is a human readable message indicating details about the transition.
conditions[].observedGenerationinteger—observedGeneration represents the .metadata.generation that the condition was set based upon.
conditions[].reasonstringyesreason contains a programmatic identifier indicating the reason for the condition's last transition.
conditions[].statusenumyesstatus of the condition, one of True, False, Unknown. Allowed: True, False, Unknown
conditions[].typestringyestype of condition in CamelCase or in foo.example.com/CamelCase.
identifierstring—Identifier is the Cloud Control primary identifier of the resource.
indexStateenum—Read-only: reported by AWS after creation. Allowed: ACTIVE, CREATING, DELETING, DELETED, UPDATING
lastSyncTimestring—
observedGenerationinteger—
operationstring—Operation is the in-flight operation (CREATE, UPDATE, DELETE).
operationStatusstring—OperationStatus is the last reported operation status.
requestTokenstring—RequestToken tracks an in-flight asynchronous operation.

ResourceExplorer2View # CLOUD CONTROL · AWS::ResourceExplorer2::View

ResourceExplorer2View manages AWS::ResourceExplorer2::View through the AWS Cloud Control API.

kubectl get resourceexplorer2views · example on GitHub

Example

# ResourceExplorer2View — Resource Explorer
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/resourceexplorer2.html#resourceexplorer2view
apiVersion: aws.konfig.io/v1alpha1
kind: ResourceExplorer2View
metadata:
  name: example-resourceexplorer2view
  namespace: default
spec:
  filters:
    filterString: example
  includedProperties:
  - name: example-includedproperties
  providerRef:
    name: example-resourceexplorer2view
    region: us-east-1
  scope: example
  tags:
    environment: dev
    team: platform
  viewName: example-resourceexplorer2view

Spec

FieldTypeRequiredDescription
filtersobject—ResourceExplorer2ViewSearchFilter is a nested property type of AWS::ResourceExplorer2::View.
filters.filterStringstringyes
includedPropertiesarray<object>—
includedProperties[].namestringyes
providerRefobject—ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
providerRef.namestringyesName of a cluster-scoped AWSProvider.
providerRef.regionstring—Region overrides the provider's region for this resource only.
scopestring—Create-only in AWS: changing it requires replacing the resource.
tagsmap<string>—
viewNamestringyesCreate-only in AWS: changing it requires replacing the resource.

Status

FieldTypeRequiredDescription
attemptinteger—Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
awsProviderobject—AWSProvider confirms the account and region this resource was reconciled against.
awsProvider.accountIdstring—AccountID the resource lives in.
awsProvider.namestring—Name of the AWSProvider used; empty when the operator's own credentials were used.
awsProvider.regionstring—Region the resource lives in (empty for global services).
conditionsarray<object>—Conditions describe the current state of the resource.
conditions[].lastTransitionTimestringyeslastTransitionTime is the last time the condition transitioned from one status to another.
conditions[].messagestringyesmessage is a human readable message indicating details about the transition.
conditions[].observedGenerationinteger—observedGeneration represents the .metadata.generation that the condition was set based upon.
conditions[].reasonstringyesreason contains a programmatic identifier indicating the reason for the condition's last transition.
conditions[].statusenumyesstatus of the condition, one of True, False, Unknown. Allowed: True, False, Unknown
conditions[].typestringyestype of condition in CamelCase or in foo.example.com/CamelCase.
identifierstring—Identifier is the Cloud Control primary identifier of the resource.
lastSyncTimestring—
observedGenerationinteger—
operationstring—Operation is the in-flight operation (CREATE, UPDATE, DELETE).
operationStatusstring—OperationStatus is the last reported operation status.
requestTokenstring—RequestToken tracks an in-flight asynchronous operation.
viewArnstring—Read-only: reported by AWS after creation.