API Gateway

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

API Group: aws.konfig.io/v1alpha1

ApiGatewayAccount # CLOUD CONTROL · AWS::ApiGateway::Account ⚠ DESTRUCTIVE SCOPE

Caution, destructive scope: account-wide API Gateway settings singleton. Provided for completeness; do not use from application namespaces. Restrict with AWSProvider.allowedNamespaces and RBAC. ApiGatewayAccount manages AWS::ApiGateway::Account through the AWS Cloud Control API.

kubectl get apigatewayaccounts · example on GitHub

Example

# ApiGatewayAccount — API Gateway
# 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/apigateway.html#apigatewayaccount
apiVersion: aws.konfig.io/v1alpha1
kind: ApiGatewayAccount
metadata:
  name: example-apigatewayaccount
  namespace: default
spec:
  cloudWatchRoleArn: arn:aws:iam::123456789012:role/example-role
  providerRef:
    name: example-apigatewayaccount
    region: us-east-1

Spec

FieldTypeRequiredDescription
cloudWatchRoleArnstring—
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.
idstring—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.

ApiGatewayApiKey # CLOUD CONTROL · AWS::ApiGateway::ApiKey ⚠ DESTRUCTIVE SCOPE

Caution, destructive scope: API key value is credential material. Provided for completeness; do not use from application namespaces. Restrict with AWSProvider.allowedNamespaces and RBAC. ApiGatewayApiKey manages AWS::ApiGateway::ApiKey through the AWS Cloud Control API.

kubectl get apigatewayapikeys · example on GitHub

Example

# ApiGatewayApiKey — API Gateway
# 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/apigateway.html#apigatewayapikey
apiVersion: aws.konfig.io/v1alpha1
kind: ApiGatewayApiKey
metadata:
  name: example-apigatewayapikey
  namespace: default
spec:
  description: Managed by konfig-konector
  enabled: true
  generateDistinctId: false
  name: example-apigatewayapikey
  providerRef:
    name: example-apigatewayapikey
    region: us-east-1
  stageKeys:
  - stageName: example-apigatewayapikey
  tags:
  - key: example
    value: example
  value: example

Spec

FieldTypeRequiredDescription
customerIdstring—
descriptionstring—
enabledboolean—
generateDistinctIdboolean—Create-only in AWS: changing it requires replacing the resource.
namestring—A name for the API key.
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.
stageKeysarray<object>—
stageKeys[].restApiIdstring—
stageKeys[].stageNamestring—
tagsarray<object>—
tags[].keystringyes
tags[].valuestringyes
valuestring—Create-only in AWS: changing it requires replacing the resource.

Status

FieldTypeRequiredDescription
apiKeyIdstring—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.
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.

ApiGatewayAuthorizer # CLOUD CONTROL · AWS::ApiGateway::Authorizer

ApiGatewayAuthorizer manages AWS::ApiGateway::Authorizer through the AWS Cloud Control API.

kubectl get apigatewayauthorizers · example on GitHub

Example

# ApiGatewayAuthorizer — API Gateway
# 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/apigateway.html#apigatewayauthorizer
apiVersion: aws.konfig.io/v1alpha1
kind: ApiGatewayAuthorizer
metadata:
  name: example-apigatewayauthorizer
  namespace: default
spec:
  authType: example
  authorizerCredentials: example
  authorizerResultTtlInSeconds: 300
  authorizerUri: example
  identitySource: example
  identityValidationExpression: example
  name: example-apigatewayauthorizer
  providerARNs:
  - example
  providerRef:
    name: example-apigatewayauthorizer
    region: us-east-1
  restApiId: example-id
  type: example

Spec

FieldTypeRequiredDescription
authTypestring—
authorizerCredentialsstring—
authorizerResultTtlInSecondsinteger—
authorizerUristring—
identitySourcestring—
identityValidationExpressionstring—
namestringyes
providerARNsarray<string>—
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.
restApiIdstringyesCreate-only in AWS: changing it requires replacing the resource.
typestringyes

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.
authorizerIdstring—Read-only: reported by AWS after creation.
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.

ApiGatewayBasePathMapping # CLOUD CONTROL · AWS::ApiGateway::BasePathMapping

ApiGatewayBasePathMapping manages AWS::ApiGateway::BasePathMapping through the AWS Cloud Control API.

kubectl get apigatewaybasepathmappings · example on GitHub

Example

# ApiGatewayBasePathMapping — API Gateway
# 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/apigateway.html#apigatewaybasepathmapping
apiVersion: aws.konfig.io/v1alpha1
kind: ApiGatewayBasePathMapping
metadata:
  name: example-apigatewaybasepathmapping
  namespace: default
spec:
  basePath: example
  domainName: example-apigatewaybasepathmapping
  providerRef:
    name: example-apigatewaybasepathmapping
    region: us-east-1
  stage: example

Spec

FieldTypeRequiredDescription
basePathstring—Create-only in AWS: changing it requires replacing the resource.
domainNamestringyesCreate-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.
restApiIdstring—
stagestring—

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.

ApiGatewayBasePathMappingV2 # CLOUD CONTROL · AWS::ApiGateway::BasePathMappingV2

ApiGatewayBasePathMappingV2 manages AWS::ApiGateway::BasePathMappingV2 through the AWS Cloud Control API.

kubectl get apigatewaybasepathmappingv2s · example on GitHub

Example

# ApiGatewayBasePathMappingV2 — API Gateway
# 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/apigateway.html#apigatewaybasepathmappingv2
apiVersion: aws.konfig.io/v1alpha1
kind: ApiGatewayBasePathMappingV2
metadata:
  name: example-apigatewaybasepathmappingv2
  namespace: default
spec:
  basePath: example
  domainNameArn: arn:aws:iam::123456789012:role/example-role
  providerRef:
    name: example-apigatewaybasepathmappingv2
    region: us-east-1
  restApiId: example-id
  stage: example

Spec

FieldTypeRequiredDescription
basePathstring—The base path name that callers of the API must provide in the URL after the domain name.
domainNameArnstringyesThe Arn of an AWS::ApiGateway::DomainNameV2 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.
restApiIdstringyesThe ID of the API.
stagestring—The name of the API's stage.

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).
basePathMappingArnstring—Amazon Resource Name (ARN) of the resource.
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.

ApiGatewayClientCertificate # CLOUD CONTROL · AWS::ApiGateway::ClientCertificate

ApiGatewayClientCertificate manages AWS::ApiGateway::ClientCertificate through the AWS Cloud Control API.

kubectl get apigatewayclientcertificates · example on GitHub

Example

# ApiGatewayClientCertificate — API Gateway
# 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/apigateway.html#apigatewayclientcertificate
apiVersion: aws.konfig.io/v1alpha1
kind: ApiGatewayClientCertificate
metadata:
  name: example-apigatewayclientcertificate
  namespace: default
spec:
  description: Managed by konfig-konector
  providerRef:
    name: example-apigatewayclientcertificate
    region: us-east-1
  tags:
  - key: example
    value: example

Spec

FieldTypeRequiredDescription
descriptionstring—
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.
tagsarray<object>—
tags[].keystringyes
tags[].valuestringyes

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).
clientCertificateIdstring—Read-only: reported by AWS after creation.
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.

ApiGatewayDocumentationPart # CLOUD CONTROL · AWS::ApiGateway::DocumentationPart

ApiGatewayDocumentationPart manages AWS::ApiGateway::DocumentationPart through the AWS Cloud Control API.

kubectl get apigatewaydocumentationparts · example on GitHub

Example

# ApiGatewayDocumentationPart — API Gateway
# 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/apigateway.html#apigatewaydocumentationpart
apiVersion: aws.konfig.io/v1alpha1
kind: ApiGatewayDocumentationPart
metadata:
  name: example-apigatewaydocumentationpart
  namespace: default
spec:
  location:
    method: example
    name: example-apigatewaydocumentationpart
    path: example
    statusCode: example
    type: API
  properties: example
  providerRef:
    name: example-apigatewaydocumentationpart
    region: us-east-1
  restApiId: example-id

Spec

FieldTypeRequiredDescription
locationobjectyesCreate-only in AWS: changing it requires replacing the resource.
location.methodstring—
location.namestring—
location.pathstring—
location.statusCodestring—
location.typeenum—Allowed: API, AUTHORIZER, MODEL, RESOURCE, METHOD, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER…
propertiesstringyes
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.
restApiIdstringyesCreate-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.
documentationPartIdstring—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.

ApiGatewayDocumentationVersion # CLOUD CONTROL · AWS::ApiGateway::DocumentationVersion

ApiGatewayDocumentationVersion manages AWS::ApiGateway::DocumentationVersion through the AWS Cloud Control API.

kubectl get apigatewaydocumentationversions · example on GitHub

Example

# ApiGatewayDocumentationVersion — API Gateway
# 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/apigateway.html#apigatewaydocumentationversion
apiVersion: aws.konfig.io/v1alpha1
kind: ApiGatewayDocumentationVersion
metadata:
  name: example-apigatewaydocumentationversion
  namespace: default
spec:
  description: Managed by konfig-konector
  documentationVersion: '1.0'
  providerRef:
    name: example-apigatewaydocumentationversion
    region: us-east-1
  restApiId: example-id

Spec

FieldTypeRequiredDescription
descriptionstring—
documentationVersionstringyesCreate-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.
restApiIdstringyesCreate-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.

ApiGatewayDomainName # CLOUD CONTROL · AWS::ApiGateway::DomainName

ApiGatewayDomainName manages AWS::ApiGateway::DomainName through the AWS Cloud Control API.

kubectl get apigatewaydomainnames · example on GitHub

Example

# ApiGatewayDomainName — API Gateway
# 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/apigateway.html#apigatewaydomainname
apiVersion: aws.konfig.io/v1alpha1
kind: ApiGatewayDomainName
metadata:
  name: example-apigatewaydomainname
  namespace: default
spec:
  certificateArn: arn:aws:iam::123456789012:role/example-role
  domainName: example-apigatewaydomainname
  endpointAccessMode: example
  endpointConfiguration:
    ipAddressType: example
    types:
    - example
  mutualTlsAuthentication:
    truststoreUri: example
    truststoreVersion: '1.0'
  ownershipVerificationCertificateArn: arn:aws:iam::123456789012:role/example-role
  providerRef:
    name: example-apigatewaydomainname
    region: us-east-1
  regionalCertificateArn: arn:aws:iam::123456789012:role/example-role
  routingMode: BASE_PATH_MAPPING_ONLY
  securityPolicy: example
  tags:
  - key: example
    value: example

Spec

FieldTypeRequiredDescription
certificateArnstring—
domainNamestring—Create-only in AWS: changing it requires replacing the resource.
endpointAccessModestring—
endpointConfigurationobject—The endpoint configuration of this DomainName showing the endpoint types and IP address types of the domain name.
endpointConfiguration.ipAddressTypestring—
endpointConfiguration.typesarray<string>—
mutualTlsAuthenticationobject—ApiGatewayDomainNameMutualTlsAuthentication is a nested property type of AWS::ApiGateway::DomainName.
mutualTlsAuthentication.truststoreUristring—
mutualTlsAuthentication.truststoreVersionstring—
ownershipVerificationCertificateArnstring—The ARN of the public certificate issued by ACM to validate ownership of your custom domain.
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.
regionalCertificateArnstring—
routingModeenum—Allowed: BASE_PATH_MAPPING_ONLY, ROUTING_RULE_THEN_BASE_PATH_MAPPING, ROUTING_RULE_ONLY
securityPolicystring—
tagsarray<object>—
tags[].keystringyes
tags[].valuestringyes

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.
distributionDomainNamestring—Read-only: reported by AWS after creation.
distributionHostedZoneIdstring—Read-only: reported by AWS after creation.
domainNameArnstring—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.
regionalDomainNamestring—Read-only: reported by AWS after creation.
regionalHostedZoneIdstring—Read-only: reported by AWS after creation.
requestTokenstring—RequestToken tracks an in-flight asynchronous operation.

ApiGatewayDomainNameAccessAssociation # CLOUD CONTROL · AWS::ApiGateway::DomainNameAccessAssociation

ApiGatewayDomainNameAccessAssociation manages AWS::ApiGateway::DomainNameAccessAssociation through the AWS Cloud Control API.

kubectl get apigatewaydomainnameaccessassociations · example on GitHub

Example

# ApiGatewayDomainNameAccessAssociation — API Gateway
# 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/apigateway.html#apigatewaydomainnameaccessassociation
apiVersion: aws.konfig.io/v1alpha1
kind: ApiGatewayDomainNameAccessAssociation
metadata:
  name: example-apigatewaydomainnameaccessassociation
  namespace: default
spec:
  accessAssociationSource: example
  accessAssociationSourceType: VPCE
  domainNameArn: arn:aws:iam::123456789012:role/example-role
  providerRef:
    name: example-apigatewaydomainnameaccessassociation
    region: us-east-1
  tags:
  - key: example
    value: example

Spec

FieldTypeRequiredDescription
accessAssociationSourcestringyesThe source of the domain name access association resource.
accessAssociationSourceTypeenumyesThe source type of the domain name access association resource. Allowed: VPCE
domainNameArnstringyesThe amazon resource name (ARN) of the domain name 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.
tagsarray<object>—An array of arbitrary tags (key-value pairs) to associate with the domainname access association.
tags[].keystringyes
tags[].valuestringyes

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.
domainNameAccessAssociationArnstring—The amazon resource name (ARN) of the domain name access association resource.
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.

ApiGatewayDomainNameV2 # CLOUD CONTROL · AWS::ApiGateway::DomainNameV2

ApiGatewayDomainNameV2 manages AWS::ApiGateway::DomainNameV2 through the AWS Cloud Control API.

kubectl get apigatewaydomainnamev2s · example on GitHub

Example

# ApiGatewayDomainNameV2 — API Gateway
# 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/apigateway.html#apigatewaydomainnamev2
apiVersion: aws.konfig.io/v1alpha1
kind: ApiGatewayDomainNameV2
metadata:
  name: example-apigatewaydomainnamev2
  namespace: default
spec:
  certificateArn: arn:aws:iam::123456789012:role/example-role
  domainName: example-apigatewaydomainnamev2
  endpointAccessMode: example
  endpointConfiguration:
    ipAddressType: example
    types:
    - example
  providerRef:
    name: example-apigatewaydomainnamev2
    region: us-east-1
  routingMode: BASE_PATH_MAPPING_ONLY
  securityPolicy: example
  tags:
  - key: example
    value: example

Spec

FieldTypeRequiredDescription
certificateArnstring—
domainNamestring—Create-only in AWS: changing it requires replacing the resource.
endpointAccessModestring—
endpointConfigurationobject—Create-only in AWS: changing it requires replacing the resource.
endpointConfiguration.ipAddressTypestring—
endpointConfiguration.typesarray<string>—
policyobject—
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.
routingModeenum—The valid routing modes are [BASE_PATH_MAPPING_ONLY], [ROUTING_RULE_THEN_BASE_PATH_MAPPING] and [ROUTING_RULE_ONLY]. Allowed: BASE_PATH_MAPPING_ONLY, ROUTING_RULE_THEN_BASE_PATH_MAPPING, ROUTING_RULE_ONLY
securityPolicystring—Create-only in AWS: changing it requires replacing the resource.
tagsarray<object>—
tags[].keystringyes
tags[].valuestringyes

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.
domainNameArnstring—The amazon resource name (ARN) of the domain name resource.
domainNameIdstring—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.

ApiGatewayGatewayResponse # CLOUD CONTROL · AWS::ApiGateway::GatewayResponse

ApiGatewayGatewayResponse manages AWS::ApiGateway::GatewayResponse through the AWS Cloud Control API.

kubectl get apigatewaygatewayresponses · example on GitHub

Example

# ApiGatewayGatewayResponse — API Gateway
# 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/apigateway.html#apigatewaygatewayresponse
apiVersion: aws.konfig.io/v1alpha1
kind: ApiGatewayGatewayResponse
metadata:
  name: example-apigatewaygatewayresponse
  namespace: default
spec:
  providerRef:
    name: example-apigatewaygatewayresponse
    region: us-east-1
  responseParameters:
    key: value
  responseTemplates:
    key: value
  responseType: example
  restApiId: example-id
  statusCode: example

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.
responseParametersmap<string>—
responseTemplatesmap<string>—
responseTypestringyesCreate-only in AWS: changing it requires replacing the resource.
restApiIdstringyesCreate-only in AWS: changing it requires replacing the resource.
statusCodestring—

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.
idstring—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.

ApiGatewayMethod # CLOUD CONTROL · AWS::ApiGateway::Method

ApiGatewayMethod manages AWS::ApiGateway::Method through the AWS Cloud Control API.

kubectl get apigatewaymethods · example on GitHub

Example

# ApiGatewayMethod — API Gateway
# 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/apigateway.html#apigatewaymethod
apiVersion: aws.konfig.io/v1alpha1
kind: ApiGatewayMethod
metadata:
  name: example-apigatewaymethod
  namespace: default
spec:
  apiKeyRequired: false
  authorizationScopes:
  - example
  authorizationType: example
  httpMethod: example
  integration:
    cacheKeyParameters:
    - example
    cacheNamespace: example
    connectionType: INTERNET
    contentHandling: CONVERT_TO_BINARY
    credentials: example
    integrationHttpMethod: example
    integrationResponses:
    - contentHandling: CONVERT_TO_BINARY
      selectionPattern: example
      statusCode: example
    integrationTarget: example
    passthroughBehavior: WHEN_NO_MATCH
    requestParameters:
      key: value
    requestTemplates:
      key: value
    responseTransferMode: BUFFERED
    timeoutInMillis: 50
    type: AWS
    uri: example
  methodResponses:
  - responseModels:
      key: value
    responseParameters: {}
    statusCode: example
  operationName: example-apigatewaymethod
  providerRef:
    name: example-apigatewaymethod
    region: us-east-1
  requestModels:
    key: value
  requestParameters: {}
  resourceId: example-id
  restApiId: example-id

Spec

FieldTypeRequiredDescription
apiKeyRequiredboolean—
authorizationScopesarray<string>—
authorizationTypestring—The method's authorization type.
authorizerIdstring—
httpMethodstringyesCreate-only in AWS: changing it requires replacing the resource.
integrationobject—ApiGatewayMethodIntegration is a nested property type of AWS::ApiGateway::Method.
integration.cacheKeyParametersarray<string>—
integration.cacheNamespacestring—
integration.connectionIdstring—
integration.connectionTypeenum—Allowed: INTERNET, VPC_LINK
integration.contentHandlingenum—Allowed: CONVERT_TO_BINARY, CONVERT_TO_TEXT
integration.credentialsstring—
integration.integrationHttpMethodstring—
integration.integrationResponsesarray<object>—
integration.integrationResponses[].contentHandlingenum—Allowed: CONVERT_TO_BINARY, CONVERT_TO_TEXT
integration.integrationResponses[].responseParametersmap<string>—
integration.integrationResponses[].responseTemplatesmap<string>—
integration.integrationResponses[].selectionPatternstring—
integration.integrationResponses[].statusCodestringyes
integration.integrationTargetstring—
integration.passthroughBehaviorenum—Allowed: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, NEVER
integration.requestParametersmap<string>—
integration.requestTemplatesmap<string>—
integration.responseTransferModeenum—Allowed: BUFFERED, STREAM
integration.timeoutInMillisinteger—
integration.typeenumyesAllowed: AWS, AWS_PROXY, HTTP, HTTP_PROXY, MOCK
integration.uristring—
methodResponsesarray<object>—
methodResponses[].responseModelsmap<string>—
methodResponses[].responseParametersmap<string>—
methodResponses[].statusCodestringyes
operationNamestring—
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.
requestModelsmap<string>—
requestParametersmap<string>—
requestValidatorIdstring—
resourceIdstringyesCreate-only in AWS: changing it requires replacing the resource.
restApiIdstringyesCreate-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.

ApiGatewayModel # CLOUD CONTROL · AWS::ApiGateway::Model

ApiGatewayModel manages AWS::ApiGateway::Model through the AWS Cloud Control API.

kubectl get apigatewaymodels · example on GitHub

Example

# ApiGatewayModel — API Gateway
# 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/apigateway.html#apigatewaymodel
apiVersion: aws.konfig.io/v1alpha1
kind: ApiGatewayModel
metadata:
  name: example-apigatewaymodel
  namespace: default
spec:
  contentType: example
  description: Managed by konfig-konector
  name: example-apigatewaymodel
  providerRef:
    name: example-apigatewaymodel
    region: us-east-1
  restApiId: example-id

Spec

FieldTypeRequiredDescription
contentTypestring—Create-only in AWS: changing it requires replacing the resource.
descriptionstring—
namestring—A name for the model.
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.
restApiIdstringyesCreate-only in AWS: changing it requires replacing the resource.
schemaobject—

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.

ApiGatewayRequestValidator # CLOUD CONTROL · AWS::ApiGateway::RequestValidator

ApiGatewayRequestValidator manages AWS::ApiGateway::RequestValidator through the AWS Cloud Control API.

kubectl get apigatewayrequestvalidators · example on GitHub

Example

# ApiGatewayRequestValidator — API Gateway
# 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/apigateway.html#apigatewayrequestvalidator
apiVersion: aws.konfig.io/v1alpha1
kind: ApiGatewayRequestValidator
metadata:
  name: example-apigatewayrequestvalidator
  namespace: default
spec:
  name: example-apigatewayrequestvalidator
  providerRef:
    name: example-apigatewayrequestvalidator
    region: us-east-1
  restApiId: example-id
  validateRequestBody: false
  validateRequestParameters: false

Spec

FieldTypeRequiredDescription
namestring—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.
restApiIdstringyesCreate-only in AWS: changing it requires replacing the resource.
validateRequestBodyboolean—
validateRequestParametersboolean—

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.
requestValidatorIdstring—Read-only: reported by AWS after creation.

ApiGatewayResource # CLOUD CONTROL · AWS::ApiGateway::Resource

ApiGatewayResource manages AWS::ApiGateway::Resource through the AWS Cloud Control API.

kubectl get apigatewayresources · example on GitHub

Example

# ApiGatewayResource — API Gateway
# 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/apigateway.html#apigatewayresource
apiVersion: aws.konfig.io/v1alpha1
kind: ApiGatewayResource
metadata:
  name: example-apigatewayresource
  namespace: default
spec:
  parentId: example-id
  pathPart: example
  providerRef:
    name: example-apigatewayresource
    region: us-east-1
  restApiId: example-id

Spec

FieldTypeRequiredDescription
parentIdstringyesCreate-only in AWS: changing it requires replacing the resource.
pathPartstringyesCreate-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.
restApiIdstringyesCreate-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.
resourceIdstring—Read-only: reported by AWS after creation.

ApiGatewayUsagePlan # CLOUD CONTROL · AWS::ApiGateway::UsagePlan

ApiGatewayUsagePlan manages AWS::ApiGateway::UsagePlan through the AWS Cloud Control API.

kubectl get apigatewayusageplans · example on GitHub

Example

# ApiGatewayUsagePlan — API Gateway
# 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/apigateway.html#apigatewayusageplan
apiVersion: aws.konfig.io/v1alpha1
kind: ApiGatewayUsagePlan
metadata:
  name: example-apigatewayusageplan
  namespace: default
spec:
  apiStages:
  - stage: example
    throttle: {}
  description: Managed by konfig-konector
  providerRef:
    name: example-apigatewayusageplan
    region: us-east-1
  quota:
    limit: 1
    offset: 1
    period: example
  tags:
  - key: example
    value: example
  throttle:
    burstLimit: 1
    rateLimit: 1
  usagePlanName: example-apigatewayusageplan

Spec

FieldTypeRequiredDescription
apiStagesarray<object>—
apiStages[].apiIdstring—
apiStages[].stagestring—
apiStages[].throttlemap<string>—
descriptionstring—
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.
quotaobject—ApiGatewayUsagePlanQuotaSettings is a nested property type of AWS::ApiGateway::UsagePlan.
quota.limitinteger—
quota.offsetinteger—
quota.periodstring—
tagsarray<object>—
tags[].keystringyes
tags[].valuestringyes
throttleobject—ApiGatewayUsagePlanThrottleSettings is a nested property type of AWS::ApiGateway::UsagePlan.
throttle.burstLimitinteger—
throttle.rateLimitnumber—
usagePlanNamestring—

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.
idstring—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.

ApiGatewayUsagePlanKey # CLOUD CONTROL · AWS::ApiGateway::UsagePlanKey

ApiGatewayUsagePlanKey manages AWS::ApiGateway::UsagePlanKey through the AWS Cloud Control API.

kubectl get apigatewayusageplankeys · example on GitHub

Example

# ApiGatewayUsagePlanKey — API Gateway
# 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/apigateway.html#apigatewayusageplankey
apiVersion: aws.konfig.io/v1alpha1
kind: ApiGatewayUsagePlanKey
metadata:
  name: example-apigatewayusageplankey
  namespace: default
spec:
  keyId: example-id
  keyType: API_KEY
  providerRef:
    name: example-apigatewayusageplankey
    region: us-east-1
  usagePlanId: example-id

Spec

FieldTypeRequiredDescription
keyIdstringyesThe Id of the UsagePlanKey resource.
keyTypeenumyesCreate-only in AWS: changing it requires replacing the resource. Allowed: API_KEY
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.
usagePlanIdstringyesThe Id of the UsagePlan resource representing the usage plan containing the UsagePlanKey resource representing a plan customer.

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.
idstring—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.

RestAPI # GA

RestAPI is the Schema for managing API Gateway REST APIs.

kubectl get restapis · example on GitHub

Example

# RestAPI — API Gateway
# 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/apigateway.html#restapi
apiVersion: aws.konfig.io/v1alpha1
kind: RestAPI
metadata:
  name: example-restapi
  namespace: default
spec:
  body: example
  description: Managed by konfig-konector
  disableExecuteApiEndpoint: false
  endpointTypes:
  - example
  minimumCompressionSize: 2
  name: example-restapi
  policy: '{"Version": "2012-10-17", "Statement": [{"Effect": "Allow", "Action": ["s3:GetObject"], "Resource":
    "*"}]}'
  providerRef:
    name: example-restapi
    region: us-east-1
  tags:
    environment: dev
    team: platform

Spec

FieldTypeRequiredDescription
bodystring—Body is an OpenAPI (Swagger) definition in JSON or YAML.
descriptionstring—Description of the REST API.
disableExecuteApiEndpointboolean—DisableExecuteAPIEndpoint disables the default execute-api endpoint.
endpointTypesarray<string>—EndpointTypes is the endpoint configuration (REGIONAL, EDGE, PRIVATE).
minimumCompressionSizeinteger—MinimumCompressionSize enables payload compression above this size in bytes (0-10485760).
namestringyesName of the REST API.
policystring—Policy is a JSON resource policy for the API.
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>—Tags are AWS resource tags to apply on creation.

Status

FieldTypeRequiredDescription
apiIdstring—APIID is the REST API identifier.
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.
rootResourceIdstring—RootResourceID is the ID of the API's root ("/") resource.

RestAPIDeployment # GA

RestAPIDeployment is the Schema for managing API Gateway REST API deployments.

kubectl get restapideployments · example on GitHub

Example

# RestAPIDeployment — API Gateway
# 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/apigateway.html#restapideployment
apiVersion: aws.konfig.io/v1alpha1
kind: RestAPIDeployment
metadata:
  name: example-restapideployment
  namespace: default
spec:
  description: Managed by konfig-konector
  providerRef:
    name: example-restapideployment
    region: us-east-1
  restApiRef:
    name: example-restapideployment
  stageName: example-restapideployment

Spec

FieldTypeRequiredDescription
descriptionstring—Description of the deployment.
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.
restApiRefobjectyesRestAPIRef references the RestAPI to deploy.
restApiRef.apiIdstring—APIID is a direct AWS API Gateway API ID, bypassing CR lookup.
restApiRef.namestring—Name of the API CR in the same namespace.
stageNamestring—StageName optionally creates/points a stage at the deployment.

Status

FieldTypeRequiredDescription
apiIdstring—APIID is the resolved REST API identifier the deployment was created in.
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.
deploymentIdstring—DeploymentID is the deployment identifier.
lastSyncTimestring—LastSyncTime is when the resource was last successfully reconciled.
observedGenerationinteger—ObservedGeneration is the most recent .metadata.generation reconciled.

RestAPIStage # GA

RestAPIStage is the Schema for managing API Gateway REST API stages.

kubectl get restapistages · example on GitHub

Example

# RestAPIStage — API Gateway
# 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/apigateway.html#restapistage
apiVersion: aws.konfig.io/v1alpha1
kind: RestAPIStage
metadata:
  name: example-restapistage
  namespace: default
spec:
  deploymentRef:
    name: example-restapistage
  description: Managed by konfig-konector
  providerRef:
    name: example-restapistage
    region: us-east-1
  restApiRef:
    name: example-restapistage
  stageName: example-restapistage
  tags:
    environment: dev
    team: platform
  tracingEnabled: true
  variables:
    key: value

Spec

FieldTypeRequiredDescription
deploymentRefobjectyesDeploymentRef references the RestAPIDeployment the stage points at.
deploymentRef.deploymentIdstring—DeploymentID is a direct AWS deployment ID, bypassing CR lookup.
deploymentRef.namestring—Name of a RestAPIDeployment CR in the same namespace.
descriptionstring—Description of the stage.
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.
restApiRefobjectyesRestAPIRef references the RestAPI this stage belongs to.
restApiRef.apiIdstring—APIID is a direct AWS API Gateway API ID, bypassing CR lookup.
restApiRef.namestring—Name of the API CR in the same namespace.
stageNamestringyesStageName is the name of the stage.
tagsmap<string>—Tags are AWS resource tags to apply on creation.
tracingEnabledboolean—TracingEnabled enables X-Ray tracing for the stage.
variablesmap<string>—Variables are stage variables (name/value pairs).

Status

FieldTypeRequiredDescription
apiIdstring—APIID is the resolved REST API identifier the stage was created in.
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.
stageNamestring—StageName is the stage name in AWS (also the primary identifier together with the API ID).