CloudFormation

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

API Group: aws.konfig.io/v1alpha1

CloudFormationChangeSet # CLOUD CONTROL · AWS::CloudFormation::ChangeSet

CloudFormationChangeSet manages AWS::CloudFormation::ChangeSet through the AWS Cloud Control API.

kubectl get cloudformationchangesets · example on GitHub

Example

# CloudFormationChangeSet — CloudFormation
# 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/cloudformation.html#cloudformationchangeset
apiVersion: aws.konfig.io/v1alpha1
kind: CloudFormationChangeSet
metadata:
  name: example-cloudformationchangeset
  namespace: default
spec:
  capabilities:
  - example
  changeSetName: example-cloudformationchangeset
  changeSetType: CREATE
  deploymentMode: REVERT_DRIFT
  description: Managed by konfig-konector
  importExistingResources: false
  includeNestedStacks: false
  notificationARNs:
  - example
  onStackFailure: DO_NOTHING
  providerRef:
    name: example-cloudformationchangeset
    region: us-east-1
  roleARN: arn:aws:iam::123456789012:role/example-role
  stackName: example-cloudformationchangeset
  tags:
  - key: example
    value: example
  templateBody: example
  templateURL: example
  usePreviousTemplate: false

Spec

FieldTypeRequiredDescription
capabilitiesarray<string>—The capabilities that are allowed in the stack.
changeSetNamestringyesThe name of the change set.
changeSetTypeenum—The type of change set operation. Allowed: CREATE, UPDATE, IMPORT
deploymentModeenum—Determines how CloudFormation handles configuration drift during deployment. Allowed: REVERT_DRIFT
descriptionstring—A description to help you identify this change set.
importExistingResourcesboolean—Indicates if the change set imports resources that already exist.
includeNestedStacksboolean—Creates a change set for all nested stacks specified in the template.
notificationARNsarray<string>—The ARNs of Amazon SNS topics that CloudFormation associates with the stack.
onStackFailureenum—Determines what action will be taken if stack creation fails. Allowed: DO_NOTHING, ROLLBACK, DELETE
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.
roleARNstring—The ARN of an IAM role that CloudFormation assumes when executing the change set.
stackNamestringyesThe name or unique ID of the stack for which you are creating a change set.
tagsarray<object>—Key-value pairs to associate with the change set.
tags[].keystringyes
tags[].valuestringyes
templateBodystring—A structure that contains the body of the revised template.
templateURLstring—The URL of the file that contains the revised template.
usePreviousTemplateboolean—Whether to reuse the template associated with the stack to create the change set.

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).
changeSetIdstring—The ARN of the change set.
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.
creationTimestring—The time the change set was created.
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.
stackIdstring—The unique ID of the stack.

CloudFormationGeneratedTemplate # CLOUD CONTROL · AWS::CloudFormation::GeneratedTemplate

CloudFormationGeneratedTemplate manages AWS::CloudFormation::GeneratedTemplate through the AWS Cloud Control API.

kubectl get cloudformationgeneratedtemplates · example on GitHub

Example

# CloudFormationGeneratedTemplate — CloudFormation
# 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/cloudformation.html#cloudformationgeneratedtemplate
apiVersion: aws.konfig.io/v1alpha1
kind: CloudFormationGeneratedTemplate
metadata:
  name: example-cloudformationgeneratedtemplate
  namespace: default
spec:
  generatedTemplateName: example-cloudformationgeneratedtemplate
  providerRef:
    name: example-cloudformationgeneratedtemplate
    region: us-east-1
  templateConfiguration:
    deletionPolicy: DELETE
    updateReplacePolicy: DELETE

Spec

FieldTypeRequiredDescription
generatedTemplateNamestringyesThe name assigned to the generated template.
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.
templateConfigurationobject—CloudFormationGeneratedTemplateTemplateConfiguration is a nested property type of AWS::CloudFormation::GeneratedTemplate.
templateConfiguration.deletionPolicyenum—The DeletionPolicy assigned to resources in the generated template. Allowed: DELETE, RETAIN
templateConfiguration.updateReplacePolicyenum—The UpdateReplacePolicy assigned to resources in the generated template. Allowed: DELETE, RETAIN

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.
creationTimestring—The time the generated template was created.
generatedTemplateIdstring—The Amazon Resource Name (ARN) of the generated template.
identifierstring—Identifier is the Cloud Control primary identifier of the resource.
lastSyncTimestring—
lastUpdatedTimestring—The time the generated template was last updated.
observedGenerationinteger—
operationstring—Operation is the in-flight operation (CREATE, UPDATE, DELETE).
operationStatusstring—OperationStatus is the last reported operation status.
progressobject—Read-only: reported by AWS after creation.
progress.resourcesFailedinteger—The number of resources that failed the template generation.
progress.resourcesPendinginteger—The number of resources that are still pending the template generation.
progress.resourcesProcessinginteger—The number of resources that are in-process for the template generation.
progress.resourcesSucceededinteger—The number of resources that succeeded the template generation.
requestTokenstring—RequestToken tracks an in-flight asynchronous operation.
statusenum—The status of the template generation. Allowed: CREATE_PENDING, UPDATE_PENDING, DELETE_PENDING, CREATE_IN_PROGRESS, UPDATE_IN_PROGRESS, DELETE_IN_PROGRESS, FAILED, COMPLETE
totalWarningsinteger—The number of warnings generated for this template.

CloudFormationGuardHook # CLOUD CONTROL · AWS::CloudFormation::GuardHook

CloudFormationGuardHook manages AWS::CloudFormation::GuardHook through the AWS Cloud Control API.

kubectl get cloudformationguardhooks · example on GitHub

Example

# CloudFormationGuardHook — CloudFormation
# 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/cloudformation.html#cloudformationguardhook
apiVersion: aws.konfig.io/v1alpha1
kind: CloudFormationGuardHook
metadata:
  name: example-cloudformationguardhook
  namespace: default
spec:
  alias: example
  executionRole: example
  failureMode: FAIL
  hookStatus: ENABLED
  logBucket: example
  providerRef:
    name: example-cloudformationguardhook
    region: us-east-1
  ruleLocation:
    uri: example
  stackFilters:
    filteringCriteria: ALL
    stackNames:
      exclude:
      - example
      include:
      - example
  targetOperations:
  - example

Spec

FieldTypeRequiredDescription
aliasstringyesThe typename alias for the hook.
executionRolestringyesThe execution role ARN assumed by hooks to read Guard rules from S3 and write Guard outputs to S3.
failureModeenumyesAttribute to specify CloudFormation behavior on hook failure. Allowed: FAIL, WARN
hookStatusenumyesAttribute to specify which stacks this hook applies to or should get invoked for Allowed: ENABLED, DISABLED
logBucketstring—S3 Bucket where the guard validate report will be uploaded to
optionsobject—
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.
ruleLocationobjectyesCloudFormationGuardHookS3Location is a nested property type of AWS::CloudFormation::GuardHook.
ruleLocation.uristringyesS3 uri of Guard files.
ruleLocation.versionIdstring—S3 object version
stackFiltersobject—Filters to allow hooks to target specific stack attributes
stackFilters.filteringCriteriaenumyesAttribute to specify the filtering behavior. Allowed: ALL, ANY
stackFilters.stackNamesobject—List of stack names as filters
stackFilters.stackNames.excludearray<string>—List of stack names that the hook is going to be excluded from
stackFilters.stackNames.includearray<string>—List of stack names that the hook is going to target
stackFilters.stackRolesobject—List of stack roles that are performing the stack operations.
stackFilters.stackRoles.excludearray<object>—List of stack roles that the hook is going to be excluded from
stackFilters.stackRoles.includearray<object>—List of stack roles that the hook is going to target
targetFiltersobject—Attribute to specify which targets should invoke the hook
targetOperationsarray<string>yesWhich operations should this Hook run against? Resource changes, stacks or change sets.

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.
hookArnstring—The Amazon Resource Name (ARN) of the activated hook Read-only: reported by AWS after creation.
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.

CloudFormationHookDefaultVersion # CLOUD CONTROL · AWS::CloudFormation::HookDefaultVersion

CloudFormationHookDefaultVersion manages AWS::CloudFormation::HookDefaultVersion through the AWS Cloud Control API.

kubectl get cloudformationhookdefaultversions · example on GitHub

Example

# CloudFormationHookDefaultVersion — CloudFormation
# 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/cloudformation.html#cloudformationhookdefaultversion
apiVersion: aws.konfig.io/v1alpha1
kind: CloudFormationHookDefaultVersion
metadata:
  name: example-cloudformationhookdefaultversion
  namespace: default
spec:
  providerRef:
    name: example-cloudformationhookdefaultversion
    region: us-east-1
  typeName: example-cloudformationhookdefaultversion
  typeVersionArn: 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.
typeNamestring—The name of the type being registered.
typeVersionArnstring—The Amazon Resource Name (ARN) of the type version.
versionIdstring—The ID of an existing version of the hook to set as the default.

Status

FieldTypeRequiredDescription
arnstring—The Amazon Resource Name (ARN) of the type.
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.

CloudFormationHookTypeConfig # CLOUD CONTROL · AWS::CloudFormation::HookTypeConfig

CloudFormationHookTypeConfig manages AWS::CloudFormation::HookTypeConfig through the AWS Cloud Control API.

kubectl get cloudformationhooktypeconfigs · example on GitHub

Example

# CloudFormationHookTypeConfig — CloudFormation
# 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/cloudformation.html#cloudformationhooktypeconfig
apiVersion: aws.konfig.io/v1alpha1
kind: CloudFormationHookTypeConfig
metadata:
  name: example-cloudformationhooktypeconfig
  namespace: default
spec:
  configuration: example
  configurationAlias: default
  providerRef:
    name: example-cloudformationhooktypeconfig
    region: us-east-1
  typeArn: arn:aws:iam::123456789012:role/example-role
  typeName: example-cloudformationhooktypeconfig

Spec

FieldTypeRequiredDescription
configurationstring—The configuration data for the extension, in this account and region.
configurationAliasenum—An alias by which to refer to this extension configuration data. Allowed: default
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.
typeArnstring—The Amazon Resource Name (ARN) of the type without version number.
typeNamestring—The name of the type being registered.

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.
configurationArnstring—The Amazon Resource Name (ARN) for the configuration data, in this account and region.
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.

CloudFormationHookVersion # CLOUD CONTROL · AWS::CloudFormation::HookVersion

CloudFormationHookVersion manages AWS::CloudFormation::HookVersion through the AWS Cloud Control API.

kubectl get cloudformationhookversions · example on GitHub

Example

# CloudFormationHookVersion — CloudFormation
# 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/cloudformation.html#cloudformationhookversion
apiVersion: aws.konfig.io/v1alpha1
kind: CloudFormationHookVersion
metadata:
  name: example-cloudformationhookversion
  namespace: default
spec:
  executionRoleArn: arn:aws:iam::123456789012:role/example-role
  loggingConfig:
    logGroupName: example-cloudformationhookversion
    logRoleArn: arn:aws:iam::123456789012:role/example-role
  providerRef:
    name: example-cloudformationhookversion
    region: us-east-1
  schemaHandlerPackage: example
  typeName: example-cloudformationhookversion

Spec

FieldTypeRequiredDescription
executionRoleArnstring—The Amazon Resource Name (ARN) of the IAM execution role to use to register the type.
loggingConfigobject—Specifies logging configuration information for a type.
loggingConfig.logGroupNamestring—The Amazon CloudWatch log group to which CloudFormation sends error logging information when invoking the type's handlers.
loggingConfig.logRoleArnstring—The ARN of the role that CloudFormation should assume when sending log entries to CloudWatch logs.
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.
schemaHandlerPackagestringyesA url to the S3 bucket containing the schema handler package that contains the schema, event handlers, and associated files for the type you want to register.
typeNamestringyesThe name of the type being registered.

Status

FieldTypeRequiredDescription
arnstring—The Amazon Resource Name (ARN) of the type, here the HookVersion.
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.
isDefaultVersionboolean—Indicates if this type version is the current default version Read-only: reported by AWS after creation.
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.
typeArnstring—The Amazon Resource Name (ARN) of the type without the versionID.
versionIdstring—The ID of the version of the type represented by this hook instance.
visibilityenum—The scope at which the type is visible and usable in CloudFormation operations. Allowed: PUBLIC, PRIVATE

CloudFormationLambdaHook # CLOUD CONTROL · AWS::CloudFormation::LambdaHook

CloudFormationLambdaHook manages AWS::CloudFormation::LambdaHook through the AWS Cloud Control API.

kubectl get cloudformationlambdahooks · example on GitHub

Example

# CloudFormationLambdaHook — CloudFormation
# 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/cloudformation.html#cloudformationlambdahook
apiVersion: aws.konfig.io/v1alpha1
kind: CloudFormationLambdaHook
metadata:
  name: example-cloudformationlambdahook
  namespace: default
spec:
  alias: example
  autoUpdate: false
  executionRole: example
  failureMode: FAIL
  hookStatus: ENABLED
  lambdaFunction: example
  loggingConfig:
    logGroupName: example-cloudformationlambdahook
    logRoleArn: arn:aws:iam::123456789012:role/example-role
  providerRef:
    name: example-cloudformationlambdahook
    region: us-east-1
  stackFilters:
    filteringCriteria: ALL
    stackNames:
      exclude:
      - example
      include:
      - example
  targetOperations:
  - example

Spec

FieldTypeRequiredDescription
aliasstringyesThe typename alias for the hook.
autoUpdateboolean—Whether to automatically update the extension in this account and Region when a new minor version is published by the extension publisher.
executionRolestringyesThe execution role ARN assumed by Hooks to invoke Lambda.
failureModeenumyesAttribute to specify CloudFormation behavior on hook failure. Allowed: FAIL, WARN
hookStatusenumyesAttribute to specify which stacks this hook applies to or should get invoked for Allowed: ENABLED, DISABLED
lambdaFunctionstringyesAmazon Resource Name (ARN), Partial ARN, name, version, or alias of the Lambda function to invoke with this hook.
loggingConfigobject—Contains logging configuration information for the hook.
loggingConfig.logGroupNamestringyesThe Amazon CloudWatch Logs group to which CloudFormation sends error logging information when invoking the extension's handlers.
loggingConfig.logRoleArnstringyesThe ARN of the role that CloudFormation should assume when sending log entries to CloudWatch Logs.
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.
stackFiltersobject—Filters to allow hooks to target specific stack attributes
stackFilters.filteringCriteriaenumyesAttribute to specify the filtering behavior. Allowed: ALL, ANY
stackFilters.stackNamesobject—List of stack names as filters
stackFilters.stackNames.excludearray<string>—List of stack names that the hook is going to be excluded from
stackFilters.stackNames.includearray<string>—List of stack names that the hook is going to target
stackFilters.stackRolesobject—List of stack roles that are performing the stack operations.
stackFilters.stackRoles.excludearray<object>—List of stack roles that the hook is going to be excluded from
stackFilters.stackRoles.includearray<object>—List of stack roles that the hook is going to target
targetFiltersobject—Attribute to specify which targets should invoke the hook
targetOperationsarray<string>yesWhich operations should this Hook run against? Resource changes, stacks or change sets.

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.
hookArnstring—The Amazon Resource Name (ARN) of the activated hook Read-only: reported by AWS after creation.
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.

CloudFormationModuleDefaultVersion # CLOUD CONTROL · AWS::CloudFormation::ModuleDefaultVersion

CloudFormationModuleDefaultVersion manages AWS::CloudFormation::ModuleDefaultVersion through the AWS Cloud Control API.

kubectl get cloudformationmoduledefaultversions · example on GitHub

Example

# CloudFormationModuleDefaultVersion — CloudFormation
# 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/cloudformation.html#cloudformationmoduledefaultversion
apiVersion: aws.konfig.io/v1alpha1
kind: CloudFormationModuleDefaultVersion
metadata:
  name: example-cloudformationmoduledefaultversion
  namespace: default
spec:
  arn: arn:aws:iam::123456789012:role/example-role
  moduleName: example-cloudformationmoduledefaultversion
  providerRef:
    name: example-cloudformationmoduledefaultversion
    region: us-east-1

Spec

FieldTypeRequiredDescription
arnstring—The Amazon Resource Name (ARN) of the module version to set as the default version.
moduleNamestring—The name of a module existing in the registry.
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.
versionIdstring—The ID of an existing version of the named module to set as the default.

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.

CloudFormationModuleVersion # CLOUD CONTROL · AWS::CloudFormation::ModuleVersion

CloudFormationModuleVersion manages AWS::CloudFormation::ModuleVersion through the AWS Cloud Control API.

kubectl get cloudformationmoduleversions · example on GitHub

Example

# CloudFormationModuleVersion — CloudFormation
# 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/cloudformation.html#cloudformationmoduleversion
apiVersion: aws.konfig.io/v1alpha1
kind: CloudFormationModuleVersion
metadata:
  name: example-cloudformationmoduleversion
  namespace: default
spec:
  moduleName: example-cloudformationmoduleversion
  modulePackage: example
  providerRef:
    name: example-cloudformationmoduleversion
    region: us-east-1

Spec

FieldTypeRequiredDescription
moduleNamestringyesThe name of the module being registered.
modulePackagestringyesThe url to the S3 bucket containing the schema and template fragment for the module you want to register.
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.

Status

FieldTypeRequiredDescription
arnstring—The Amazon Resource Name (ARN) of the module.
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.
descriptionstring—The description of the registered module.
documentationUrlstring—The URL of a page providing detailed documentation for this module.
identifierstring—Identifier is the Cloud Control primary identifier of the resource.
isDefaultVersionboolean—Indicator of whether this module version is the current default version Read-only: reported by AWS after creation.
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.
schemastring—The schema defining input parameters to and resources generated by the module.
timeCreatedstring—The time that the specified module version was registered.
versionIdstring—The version ID of the module represented by this module instance.
visibilityenum—The scope at which the type is visible and usable in CloudFormation operations. Allowed: PRIVATE

CloudFormationPublicTypeVersion # CLOUD CONTROL · AWS::CloudFormation::PublicTypeVersion

CloudFormationPublicTypeVersion manages AWS::CloudFormation::PublicTypeVersion through the AWS Cloud Control API.

kubectl get cloudformationpublictypeversions · example on GitHub

Example

# CloudFormationPublicTypeVersion — CloudFormation
# 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/cloudformation.html#cloudformationpublictypeversion
apiVersion: aws.konfig.io/v1alpha1
kind: CloudFormationPublicTypeVersion
metadata:
  name: example-cloudformationpublictypeversion
  namespace: default
spec:
  arn: arn:aws:iam::123456789012:role/example-role
  logDeliveryBucket: example
  providerRef:
    name: example-cloudformationpublictypeversion
    region: us-east-1
  publicVersionNumber: example
  type: RESOURCE
  typeName: example-cloudformationpublictypeversion

Spec

FieldTypeRequiredDescription
arnstring—The Amazon Resource Number (ARN) of the extension.
logDeliveryBucketstring—A url to the S3 bucket where logs for the testType run will be available Create-only in AWS: changing it requires replacing the resource.
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.
publicVersionNumberstring—The version number of a public third-party extension Create-only in AWS: changing it requires replacing the resource.
typeenum—The kind of extension Create-only in AWS: changing it requires replacing the resource. Allowed: RESOURCE, MODULE, HOOK
typeNamestring—The name of the type being registered.

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.
publicTypeArnstring—The Amazon Resource Number (ARN) assigned to the public extension upon publication Read-only: reported by AWS after creation.
publisherIdstring—The reserved publisher id for this type, or the publisher id assigned by CloudFormation for publishing in this region.
requestTokenstring—RequestToken tracks an in-flight asynchronous operation.
typeVersionArnstring—The Amazon Resource Number (ARN) of the extension with the versionId.

CloudFormationPublisher # CLOUD CONTROL · AWS::CloudFormation::Publisher

CloudFormationPublisher manages AWS::CloudFormation::Publisher through the AWS Cloud Control API.

kubectl get cloudformationpublishers · example on GitHub

Example

# CloudFormationPublisher — CloudFormation
# 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/cloudformation.html#cloudformationpublisher
apiVersion: aws.konfig.io/v1alpha1
kind: CloudFormationPublisher
metadata:
  name: example-cloudformationpublisher
  namespace: default
spec:
  acceptTermsAndConditions: false
  connectionArn: arn:aws:iam::123456789012:role/example-role
  providerRef:
    name: example-cloudformationpublisher
    region: us-east-1

Spec

FieldTypeRequiredDescription
acceptTermsAndConditionsbooleanyesWhether you accept the terms and conditions for publishing extensions in the CloudFormation registry.
connectionArnstring—If you are using a Bitbucket or GitHub account for identity verification, the Amazon Resource Name (ARN) for your connection to that account.
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.

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.
identityProviderenum—The type of account used as the identity provider when registering this publisher with CloudFormation. Allowed: AWS_Marketplace, GitHub, Bitbucket
lastSyncTimestring—
observedGenerationinteger—
operationstring—Operation is the in-flight operation (CREATE, UPDATE, DELETE).
operationStatusstring—OperationStatus is the last reported operation status.
publisherIdstring—The reserved publisher id for this type, or the publisher id assigned by CloudFormation for publishing in this region.
publisherProfilestring—The URL to the publisher's profile with the identity provider.
publisherStatusenum—Whether the publisher is verified. Allowed: VERIFIED, UNVERIFIED
requestTokenstring—RequestToken tracks an in-flight asynchronous operation.

CloudFormationResourceDefaultVersion # CLOUD CONTROL · AWS::CloudFormation::ResourceDefaultVersion

CloudFormationResourceDefaultVersion manages AWS::CloudFormation::ResourceDefaultVersion through the AWS Cloud Control API.

kubectl get cloudformationresourcedefaultversions · example on GitHub

Example

# CloudFormationResourceDefaultVersion — CloudFormation
# 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/cloudformation.html#cloudformationresourcedefaultversion
apiVersion: aws.konfig.io/v1alpha1
kind: CloudFormationResourceDefaultVersion
metadata:
  name: example-cloudformationresourcedefaultversion
  namespace: default
spec:
  providerRef:
    name: example-cloudformationresourcedefaultversion
    region: us-east-1
  typeName: example-cloudformationresourcedefaultversion
  typeVersionArn: 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.
typeNamestring—The name of the type being registered.
typeVersionArnstring—The Amazon Resource Name (ARN) of the type version.
versionIdstring—The ID of an existing version of the resource to set as the default.

Status

FieldTypeRequiredDescription
arnstring—The Amazon Resource Name (ARN) of the type.
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.

CloudFormationResourceVersion # CLOUD CONTROL · AWS::CloudFormation::ResourceVersion

CloudFormationResourceVersion manages AWS::CloudFormation::ResourceVersion through the AWS Cloud Control API.

kubectl get cloudformationresourceversions · example on GitHub

Example

# CloudFormationResourceVersion — CloudFormation
# 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/cloudformation.html#cloudformationresourceversion
apiVersion: aws.konfig.io/v1alpha1
kind: CloudFormationResourceVersion
metadata:
  name: example-cloudformationresourceversion
  namespace: default
spec:
  executionRoleArn: arn:aws:iam::123456789012:role/example-role
  loggingConfig:
    logGroupName: example-cloudformationresourceversion
    logRoleArn: arn:aws:iam::123456789012:role/example-role
  providerRef:
    name: example-cloudformationresourceversion
    region: us-east-1
  schemaHandlerPackage: example
  typeName: example-cloudformationresourceversion

Spec

FieldTypeRequiredDescription
executionRoleArnstring—The Amazon Resource Name (ARN) of the IAM execution role to use to register the type.
loggingConfigobject—Specifies logging configuration information for a type.
loggingConfig.logGroupNamestring—The Amazon CloudWatch log group to which CloudFormation sends error logging information when invoking the type's handlers.
loggingConfig.logRoleArnstring—The ARN of the role that CloudFormation should assume when sending log entries to CloudWatch logs.
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.
schemaHandlerPackagestringyesA url to the S3 bucket containing the schema handler package that contains the schema, event handlers, and associated files for the type you want to register.
typeNamestringyesThe name of the type being registered.

Status

FieldTypeRequiredDescription
arnstring—The Amazon Resource Name (ARN) of the type, here the ResourceVersion.
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.
isDefaultVersionboolean—Indicates if this type version is the current default version Read-only: reported by AWS after creation.
lastSyncTimestring—
observedGenerationinteger—
operationstring—Operation is the in-flight operation (CREATE, UPDATE, DELETE).
operationStatusstring—OperationStatus is the last reported operation status.
provisioningTypeenum—The provisioning behavior of the type. Allowed: NON_PROVISIONABLE, IMMUTABLE, FULLY_MUTABLE
requestTokenstring—RequestToken tracks an in-flight asynchronous operation.
typeArnstring—The Amazon Resource Name (ARN) of the type without the versionID.
versionIdstring—The ID of the version of the type represented by this resource instance.
visibilityenum—The scope at which the type is visible and usable in CloudFormation operations. Allowed: PUBLIC, PRIVATE

CloudFormationStack # GA

CloudFormationStack is the Schema for managing CloudFormation stacks.

kubectl get cloudformationstacks · example on GitHub

Example

# CloudFormationStack — CloudFormation
# 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/cloudformation.html#cloudformationstack
apiVersion: aws.konfig.io/v1alpha1
kind: CloudFormationStack
metadata:
  name: example-cloudformationstack
  namespace: default
spec:
  capabilities:
  - example
  parameters:
  - parameterKey: example
    parameterValue: example
  providerRef:
    name: example-cloudformationstack
    region: us-east-1
  stackName: example-cloudformationstack
  tags:
    environment: dev
    team: platform
  templateBody: example
  templateURL: example

Spec

FieldTypeRequiredDescription
capabilitiesarray<string>—Capabilities is the list of CloudFormation capabilities (e.g.
parametersarray<object>—Parameters is the list of template parameters.
parameters[].parameterKeystringyesParameterKey is the parameter key.
parameters[].parameterValuestringyesParameterValue is the parameter value.
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.
stackNamestringyesStackName is the name of the stack.
tagsmap<string>—Tags are metadata tags for the stack.
templateBodystring—TemplateBody is the CloudFormation template body (JSON or YAML string).
templateURLstring—TemplateURL is an S3 URL for the template.

Status

FieldTypeRequiredDescription
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.
lastSyncTimestring—LastSyncTime is when the resource was last successfully reconciled.
observedGenerationinteger—ObservedGeneration is the most recent .metadata.generation reconciled.
stackIDstring—StackID is the unique identifier (ARN) of the stack.
stackStatusstring—StackStatus is the current status of the stack (CREATE_COMPLETE, UPDATE_COMPLETE, etc.).

CloudFormationStackSet # GA

CloudFormationStackSet is the Schema for managing CloudFormation StackSets.

kubectl get cloudformationstacksets · example on GitHub

Example

# CloudFormationStackSet — CloudFormation
# 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/cloudformation.html#cloudformationstackset
apiVersion: aws.konfig.io/v1alpha1
kind: CloudFormationStackSet
metadata:
  name: example-cloudformationstackset
  namespace: default
spec:
  capabilities:
  - example
  description: Managed by konfig-konector
  parameters:
  - parameterKey: example
    parameterValue: example
  providerRef:
    name: example-cloudformationstackset
    region: us-east-1
  stackSetName: example-cloudformationstackset
  tags:
    environment: dev
    team: platform
  templateBody: example
  templateURL: example

Spec

FieldTypeRequiredDescription
capabilitiesarray<string>—Capabilities is the list of CloudFormation capabilities.
descriptionstring—Description is a description of the StackSet.
parametersarray<object>—Parameters is the list of template parameters.
parameters[].parameterKeystringyesParameterKey is the parameter key.
parameters[].parameterValuestringyesParameterValue is the parameter value.
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.
stackSetNamestringyesStackSetName is the name of the StackSet.
tagsmap<string>—Tags are metadata tags for the StackSet.
templateBodystring—TemplateBody is the CloudFormation template body (JSON or YAML string).
templateURLstring—TemplateURL is an S3 URL for the template.

Status

FieldTypeRequiredDescription
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.
lastSyncTimestring—LastSyncTime is when the resource was last successfully reconciled.
observedGenerationinteger—ObservedGeneration is the most recent .metadata.generation reconciled.
stackSetIDstring—StackSetID is the unique identifier of the StackSet.
stackSetStatusstring—StackSetStatus is the current status of the StackSet.

CloudFormationTypeActivation # CLOUD CONTROL · AWS::CloudFormation::TypeActivation

CloudFormationTypeActivation manages AWS::CloudFormation::TypeActivation through the AWS Cloud Control API.

kubectl get cloudformationtypeactivations · example on GitHub

Example

# CloudFormationTypeActivation — CloudFormation
# 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/cloudformation.html#cloudformationtypeactivation
apiVersion: aws.konfig.io/v1alpha1
kind: CloudFormationTypeActivation
metadata:
  name: example-cloudformationtypeactivation
  namespace: default
spec:
  autoUpdate: false
  executionRoleArn: arn:aws:iam::123456789012:role/example-role
  loggingConfig:
    logGroupName: example-cloudformationtypeactivation
    logRoleArn: arn:aws:iam::123456789012:role/example-role
  majorVersion: '1.0'
  providerRef:
    name: example-cloudformationtypeactivation
    region: us-east-1
  publicTypeArn: arn:aws:iam::123456789012:role/example-role
  type: RESOURCE
  typeName: example-cloudformationtypeactivation
  typeNameAlias: example
  versionBump: MAJOR

Spec

FieldTypeRequiredDescription
autoUpdateboolean—Whether to automatically update the extension in this account and region when a new minor version is published by the extension publisher.
executionRoleArnstring—The Amazon Resource Name (ARN) of the IAM execution role to use to register the type.
loggingConfigobject—Specifies logging configuration information for a type.
loggingConfig.logGroupNamestring—The Amazon CloudWatch log group to which CloudFormation sends error logging information when invoking the type's handlers.
loggingConfig.logRoleArnstring—The ARN of the role that CloudFormation should assume when sending log entries to CloudWatch logs.
majorVersionstring—The Major Version of the type you want to enable
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.
publicTypeArnstring—The Amazon Resource Number (ARN) assigned to the public extension upon publication
publisherIdstring—The reserved publisher id for this type, or the publisher id assigned by CloudFormation for publishing in this region.
typeenum—The kind of extension Allowed: RESOURCE, MODULE, HOOK
typeNamestring—The name of the type being registered.
typeNameAliasstring—An alias to assign to the public extension in this account and region.
versionBumpenum—Manually updates a previously-enabled type to a new major or minor version, if available. Allowed: MAJOR, MINOR

Status

FieldTypeRequiredDescription
arnstring—The Amazon Resource Name (ARN) of the extension.
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.