Cloud Control API

1 resource kind. Generated from the operator's CRD schemas.

API Group: aws.konfig.io/v1alpha1

CloudControlResource # GA

CloudControlResource manages any AWS Cloud Control API resource type.

kubectl get cloudcontrolresources · example on GitHub

Example

# CloudControlResource — Cloud Control API
# 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/cloudcontrol.html#cloudcontrolresource
apiVersion: aws.konfig.io/v1alpha1
kind: CloudControlResource
metadata:
  name: example-cloudcontrolresource
  namespace: default
spec:
  identifier: example
  providerRef:
    name: example-cloudcontrolresource
    region: us-east-1
  roleArn: arn:aws:iam::123456789012:role/example-role
  typeName: example-cloudcontrolresource

Spec

Field	Type	Required	Description
`desiredState`	object	yes	DesiredState is the resource's properties as a JSON object, using the CloudFormation property names for the type.
`identifier`	string	—	Identifier adopts an existing resource by its Cloud Control primary identifier instead of creating a new one.
`providerRef`	object	—	ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
`providerRef.name`	string	yes	Name of a cluster-scoped AWSProvider.
`providerRef.region`	string	—	Region overrides the provider's region for this resource only.
`roleArn`	string	—	RoleARN is an IAM role Cloud Control assumes to perform the operation, instead of the caller's credentials.
`typeName`	string	yes	TypeName is the CloudFormation resource type, e.g.
`typeVersionId`	string	—	TypeVersionID pins a specific registered version of the type.

Status

Field	Type	Required	Description
`attempt`	integer	—	Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
`awsProvider`	object	—	AWSProvider confirms the account and region this resource was reconciled against.
`awsProvider.accountId`	string	—	AccountID the resource lives in.
`awsProvider.name`	string	—	Name of the AWSProvider used; empty when the operator's own credentials were used.
`awsProvider.region`	string	—	Region the resource lives in (empty for global services).
`conditions`	array<object>	—	Conditions describe the current state of the resource.
`conditions[].lastTransitionTime`	string	yes	lastTransitionTime is the last time the condition transitioned from one status to another.
`conditions[].message`	string	yes	message is a human readable message indicating details about the transition.
`conditions[].observedGeneration`	integer	—	observedGeneration represents the .metadata.generation that the condition was set based upon.
`conditions[].reason`	string	yes	reason contains a programmatic identifier indicating the reason for the condition's last transition.
`conditions[].status`	enum	yes	status of the condition, one of True, False, Unknown. Allowed: `True, False, Unknown`
`conditions[].type`	string	yes	type of condition in CamelCase or in foo.example.com/CamelCase.
`identifier`	string	—	Identifier is the Cloud Control primary identifier of the resource.
`lastSyncTime`	string	—
`observedGeneration`	integer	—
`operation`	string	—	Operation is the in-flight operation (CREATE, UPDATE, DELETE).
`operationStatus`	string	—	OperationStatus is the last reported operation status.
`properties`	object	—	Properties is the live resource model as returned by GetResource.
`requestToken`	string	—	RequestToken tracks an in-flight asynchronous operation.