API Gateway v2

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

API Group: aws.konfig.io/v1alpha1

APIGatewayV2API # GA

APIGatewayV2API is the Schema for managing API Gateway v2 (HTTP/WebSocket) APIs.

kubectl get apigatewayv2apis · example on GitHub

Example

# APIGatewayV2API — API Gateway v2
# 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/apigatewayv2.html#apigatewayv2api
apiVersion: aws.konfig.io/v1alpha1
kind: APIGatewayV2API
metadata:
  name: example-apigatewayv2api
  namespace: default
spec:
  apiKeySelectionExpression: example
  corsConfiguration:
    allowCredentials: false
    allowHeaders:
    - example
    allowMethods:
    - example
    allowOrigins:
    - example
    exposeHeaders:
    - example
    maxAge: 1
  description: Managed by konfig-konector
  disableExecuteApiEndpoint: false
  name: example-apigatewayv2api
  protocolType: HTTP
  providerRef:
    name: example-apigatewayv2api
    region: us-east-1
  routeSelectionExpression: example
  tags:
    environment: dev
    team: platform

Spec

Field	Type	Required	Description
`apiKeySelectionExpression`	string	—	APIKeySelectionExpression is supported only for WebSocket APIs.
`corsConfiguration`	object	—	CORSConfiguration configures cross-origin resource sharing.
`corsConfiguration.allowCredentials`	boolean	—	AllowCredentials specifies whether credentials are included in the CORS request.
`corsConfiguration.allowHeaders`	array<string>	—	AllowHeaders are the allowed headers.
`corsConfiguration.allowMethods`	array<string>	—	AllowMethods are the allowed HTTP methods.
`corsConfiguration.allowOrigins`	array<string>	—	AllowOrigins are the allowed origins.
`corsConfiguration.exposeHeaders`	array<string>	—	ExposeHeaders are the exposed headers.
`corsConfiguration.maxAge`	integer	—	MaxAge is the number of seconds that the browser should cache preflight results.
`description`	string	—	Description of the API.
`disableExecuteApiEndpoint`	boolean	—	DisableExecuteAPIEndpoint disables the default execute-api endpoint.
`name`	string	yes	Name is the name of the API.
`protocolType`	enum	yes	ProtocolType is the API protocol. Allowed: `HTTP, WEBSOCKET`
`providerRef`	object	—	ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
`providerRef.name`	string	yes	Name of a cluster-scoped AWSProvider.
`providerRef.region`	string	—	Region overrides the provider's region for this resource only.
`routeSelectionExpression`	string	—	RouteSelectionExpression is required for WebSocket APIs (e.g.
`tags`	map<string>	—	Tags are AWS resource tags to apply on creation.

Status

Field	Type	Required	Description
`apiEndpoint`	string	—	APIEndpoint is the default invoke URL of the API.
`apiId`	string	—	APIID is the API identifier.
`awsProvider`	object	—	AWSProvider confirms the account and region this resource was reconciled against.
`awsProvider.accountId`	string	—	AccountID the resource lives in.
`awsProvider.name`	string	—	Name of the AWSProvider used; empty when the operator's own credentials were used.
`awsProvider.region`	string	—	Region the resource lives in (empty for global services).
`conditions`	array<object>	—	Conditions describe the current state of the resource.
`conditions[].lastTransitionTime`	string	yes	lastTransitionTime is the last time the condition transitioned from one status to another.
`conditions[].message`	string	yes	message is a human readable message indicating details about the transition.
`conditions[].observedGeneration`	integer	—	observedGeneration represents the .metadata.generation that the condition was set based upon.
`conditions[].reason`	string	yes	reason contains a programmatic identifier indicating the reason for the condition's last transition.
`conditions[].status`	enum	yes	status of the condition, one of True, False, Unknown. Allowed: `True, False, Unknown`
`conditions[].type`	string	yes	type of condition in CamelCase or in foo.example.com/CamelCase.
`lastSyncTime`	string	—	LastSyncTime is when the resource was last successfully reconciled.
`observedGeneration`	integer	—	ObservedGeneration is the most recent .metadata.generation reconciled.

APIGatewayV2ApiMapping # GA

APIGatewayV2ApiMapping is the Schema for managing API Gateway v2 API mappings.

kubectl get apigatewayv2apimappings · example on GitHub

Example

# APIGatewayV2ApiMapping — API Gateway v2
# 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/apigatewayv2.html#apigatewayv2apimapping
apiVersion: aws.konfig.io/v1alpha1
kind: APIGatewayV2ApiMapping
metadata:
  name: example-apigatewayv2apimapping
  namespace: default
spec:
  apiMappingKey: example
  apiRef:
    name: example-apigatewayv2apimapping
  domainNameRef:
    domainName: example-apigatewayv2apimapping
    name: example-apigatewayv2apimapping
  providerRef:
    name: example-apigatewayv2apimapping
    region: us-east-1
  stage: example

Spec

Field	Type	Required	Description
`apiMappingKey`	string	—	APIMappingKey is the path key under the domain (empty for root).
`apiRef`	object	yes	APIRef references the APIGatewayV2API to map.
`apiRef.apiId`	string	—	APIID is a direct AWS API Gateway API ID, bypassing CR lookup.
`apiRef.name`	string	—	Name of the API CR in the same namespace.
`domainNameRef`	object	yes	DomainNameRef references the APIGatewayV2DomainName to map onto.
`domainNameRef.domainName`	string	—	DomainName is a direct AWS custom domain name, bypassing CR lookup.
`domainNameRef.name`	string	—	Name of an APIGatewayV2DomainName CR in the same namespace.
`providerRef`	object	—	ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
`providerRef.name`	string	yes	Name of a cluster-scoped AWSProvider.
`providerRef.region`	string	—	Region overrides the provider's region for this resource only.
`stage`	string	yes	Stage is the API stage to map (e.g.

Status

Field	Type	Required	Description
`apiMappingId`	string	—	APIMappingID is the mapping identifier.
`awsProvider`	object	—	AWSProvider confirms the account and region this resource was reconciled against.
`awsProvider.accountId`	string	—	AccountID the resource lives in.
`awsProvider.name`	string	—	Name of the AWSProvider used; empty when the operator's own credentials were used.
`awsProvider.region`	string	—	Region the resource lives in (empty for global services).
`conditions`	array<object>	—	Conditions describe the current state of the resource.
`conditions[].lastTransitionTime`	string	yes	lastTransitionTime is the last time the condition transitioned from one status to another.
`conditions[].message`	string	yes	message is a human readable message indicating details about the transition.
`conditions[].observedGeneration`	integer	—	observedGeneration represents the .metadata.generation that the condition was set based upon.
`conditions[].reason`	string	yes	reason contains a programmatic identifier indicating the reason for the condition's last transition.
`conditions[].status`	enum	yes	status of the condition, one of True, False, Unknown. Allowed: `True, False, Unknown`
`conditions[].type`	string	yes	type of condition in CamelCase or in foo.example.com/CamelCase.
`domainName`	string	—	DomainName is the resolved AWS domain name the mapping was created on.
`lastSyncTime`	string	—	LastSyncTime is when the resource was last successfully reconciled.
`observedGeneration`	integer	—	ObservedGeneration is the most recent .metadata.generation reconciled.

APIGatewayV2Authorizer # GA

APIGatewayV2Authorizer is the Schema for managing API Gateway v2 authorizers.

kubectl get apigatewayv2authorizers · example on GitHub

Example

# APIGatewayV2Authorizer — API Gateway v2
# 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/apigatewayv2.html#apigatewayv2authorizer
apiVersion: aws.konfig.io/v1alpha1
kind: APIGatewayV2Authorizer
metadata:
  name: example-apigatewayv2authorizer
  namespace: default
spec:
  apiRef:
    name: example-apigatewayv2authorizer
  authorizerCredentialsArn: arn:aws:iam::123456789012:role/example-role
  authorizerPayloadFormatVersion: '1.0'
  authorizerResultTtlInSeconds: 1
  authorizerType: JWT
  authorizerUri: example
  enableSimpleResponses: true
  functionRef:
    functionName: example-apigatewayv2authorizer
    name: example-apigatewayv2authorizer
  identitySource:
  - example
  jwtConfiguration:
    audience:
    - example
    issuer: example
  name: example-apigatewayv2authorizer
  providerRef:
    name: example-apigatewayv2authorizer
    region: us-east-1

Spec

Field	Type	Required	Description
`apiRef`	object	yes	APIRef references the APIGatewayV2API this authorizer belongs to.
`apiRef.apiId`	string	—	APIID is a direct AWS API Gateway API ID, bypassing CR lookup.
`apiRef.name`	string	—	Name of the API CR in the same namespace.
`authorizerCredentialsArn`	string	—	AuthorizerCredentialsARN is the IAM role for API Gateway to invoke the authorizer.
`authorizerPayloadFormatVersion`	enum	—	AuthorizerPayloadFormatVersion is 1.0 or 2.0. Allowed: `1.0, 2.0`
`authorizerResultTtlInSeconds`	integer	—	AuthorizerResultTTLInSeconds is how long authorizer results are cached.
`authorizerType`	enum	yes	AuthorizerType is JWT (HTTP APIs) or REQUEST (Lambda authorizer). Allowed: `JWT, REQUEST`
`authorizerUri`	string	—	AuthorizerURI is the Lambda authorizer invocation URI.
`enableSimpleResponses`	boolean	—	EnableSimpleResponses lets a REQUEST authorizer return a boolean response.
`functionRef`	object	—	FunctionRef references a LambdaFunction CR whose ARN is turned into the authorizer URI.
`functionRef.functionName`	string	—	FunctionName is a direct AWS Lambda function name or ARN.
`functionRef.name`	string	—	Name of a LambdaFunction CR in the same namespace.
`identitySource`	array<string>	—	IdentitySource is the list of identity sources (e.g.
`jwtConfiguration`	object	—	JWTConfiguration is required when authorizerType is JWT.
`jwtConfiguration.audience`	array<string>	—	Audience is the list of intended recipients of the JWT.
`jwtConfiguration.issuer`	string	yes	Issuer is the base domain of the identity provider that issues JWTs (e.g.
`name`	string	yes	Name of the authorizer.
`providerRef`	object	—	ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
`providerRef.name`	string	yes	Name of a cluster-scoped AWSProvider.
`providerRef.region`	string	—	Region overrides the provider's region for this resource only.

Status

Field	Type	Required	Description
`apiId`	string	—	APIID is the resolved API identifier the authorizer was created in.
`authorizerId`	string	—	AuthorizerID is the authorizer identifier.
`awsProvider`	object	—	AWSProvider confirms the account and region this resource was reconciled against.
`awsProvider.accountId`	string	—	AccountID the resource lives in.
`awsProvider.name`	string	—	Name of the AWSProvider used; empty when the operator's own credentials were used.
`awsProvider.region`	string	—	Region the resource lives in (empty for global services).
`conditions`	array<object>	—	Conditions describe the current state of the resource.
`conditions[].lastTransitionTime`	string	yes	lastTransitionTime is the last time the condition transitioned from one status to another.
`conditions[].message`	string	yes	message is a human readable message indicating details about the transition.
`conditions[].observedGeneration`	integer	—	observedGeneration represents the .metadata.generation that the condition was set based upon.
`conditions[].reason`	string	yes	reason contains a programmatic identifier indicating the reason for the condition's last transition.
`conditions[].status`	enum	yes	status of the condition, one of True, False, Unknown. Allowed: `True, False, Unknown`
`conditions[].type`	string	yes	type of condition in CamelCase or in foo.example.com/CamelCase.
`lastSyncTime`	string	—	LastSyncTime is when the resource was last successfully reconciled.
`observedGeneration`	integer	—	ObservedGeneration is the most recent .metadata.generation reconciled.

APIGatewayV2DomainName # GA

APIGatewayV2DomainName is the Schema for managing API Gateway v2 custom domain names.

kubectl get apigatewayv2domainnames · example on GitHub

Example

# APIGatewayV2DomainName — API Gateway v2
# 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/apigatewayv2.html#apigatewayv2domainname
apiVersion: aws.konfig.io/v1alpha1
kind: APIGatewayV2DomainName
metadata:
  name: example-apigatewayv2domainname
  namespace: default
spec:
  certificateArn: arn:aws:iam::123456789012:role/example-role
  domainName: example-apigatewayv2domainname
  endpointType: REGIONAL
  providerRef:
    name: example-apigatewayv2domainname
    region: us-east-1
  securityPolicy: TLS_1_0
  tags:
    environment: dev
    team: platform

Spec

Field	Type	Required	Description
`certificateArn`	string	yes	CertificateARN is the ACM certificate ARN for the domain.
`domainName`	string	yes	DomainName is the custom domain name (e.g.
`endpointType`	enum	—	EndpointType is the endpoint type. Allowed: `REGIONAL, EDGE`
`providerRef`	object	—	ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
`providerRef.name`	string	yes	Name of a cluster-scoped AWSProvider.
`providerRef.region`	string	—	Region overrides the provider's region for this resource only.
`securityPolicy`	enum	—	SecurityPolicy is the TLS security policy. Allowed: `TLS_1_0, TLS_1_2`
`tags`	map<string>	—	Tags are AWS resource tags to apply on creation.

Status

Field	Type	Required	Description
`apiGatewayDomainName`	string	—	APIGatewayDomainName is the AWS-managed regional domain name to CNAME to.
`awsProvider`	object	—	AWSProvider confirms the account and region this resource was reconciled against.
`awsProvider.accountId`	string	—	AccountID the resource lives in.
`awsProvider.name`	string	—	Name of the AWSProvider used; empty when the operator's own credentials were used.
`awsProvider.region`	string	—	Region the resource lives in (empty for global services).
`conditions`	array<object>	—	Conditions describe the current state of the resource.
`conditions[].lastTransitionTime`	string	yes	lastTransitionTime is the last time the condition transitioned from one status to another.
`conditions[].message`	string	yes	message is a human readable message indicating details about the transition.
`conditions[].observedGeneration`	integer	—	observedGeneration represents the .metadata.generation that the condition was set based upon.
`conditions[].reason`	string	yes	reason contains a programmatic identifier indicating the reason for the condition's last transition.
`conditions[].status`	enum	yes	status of the condition, one of True, False, Unknown. Allowed: `True, False, Unknown`
`conditions[].type`	string	yes	type of condition in CamelCase or in foo.example.com/CamelCase.
`domainName`	string	—	DomainName is the domain name in AWS (also the primary identifier).
`hostedZoneId`	string	—	HostedZoneID is the Route53 hosted zone ID of the regional endpoint.
`lastSyncTime`	string	—	LastSyncTime is when the resource was last successfully reconciled.
`observedGeneration`	integer	—	ObservedGeneration is the most recent .metadata.generation reconciled.

APIGatewayV2Integration # GA

APIGatewayV2Integration is the Schema for managing API Gateway v2 integrations.

kubectl get apigatewayv2integrations · example on GitHub

Example

# APIGatewayV2Integration — API Gateway v2
# 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/apigatewayv2.html#apigatewayv2integration
apiVersion: aws.konfig.io/v1alpha1
kind: APIGatewayV2Integration
metadata:
  name: example-apigatewayv2integration
  namespace: default
spec:
  apiRef:
    name: example-apigatewayv2integration
  connectionType: INTERNET
  credentialsArn: arn:aws:iam::123456789012:role/example-role
  description: Managed by konfig-konector
  functionRef:
    functionName: example-apigatewayv2integration
    name: example-apigatewayv2integration
  integrationMethod: example
  integrationType: AWS
  integrationUri: example
  payloadFormatVersion: '1.0'
  providerRef:
    name: example-apigatewayv2integration
    region: us-east-1
  requestParameters:
    key: value
  timeoutInMillis: 50
  vpcLinkRef:
    name: example-vpclink

Spec

Field	Type	Required	Description
`apiRef`	object	yes	APIRef references the APIGatewayV2API this integration belongs to.
`apiRef.apiId`	string	—	APIID is a direct AWS API Gateway API ID, bypassing CR lookup.
`apiRef.name`	string	—	Name of the API CR in the same namespace.
`connectionId`	string	—	ConnectionID is a direct VPC link ID used when connectionType is VPC_LINK, bypassing CR lookup.
`connectionType`	enum	—	ConnectionType is INTERNET or VPC_LINK. Allowed: `INTERNET, VPC_LINK`
`credentialsArn`	string	—	CredentialsARN is the credentials for the integration.
`description`	string	—	Description of the integration.
`functionRef`	object	—	FunctionRef references a LambdaFunction CR whose ARN becomes the integration URI.
`functionRef.functionName`	string	—	FunctionName is a direct AWS Lambda function name or ARN.
`functionRef.name`	string	—	Name of a LambdaFunction CR in the same namespace.
`integrationMethod`	string	—	IntegrationMethod is the HTTP method for HTTP integrations (e.g.
`integrationType`	enum	yes	IntegrationType is the integration type. Allowed: `AWS, AWS_PROXY, HTTP, HTTP_PROXY, MOCK`
`integrationUri`	string	—	IntegrationURI is the raw integration URI (e.g.
`payloadFormatVersion`	enum	—	PayloadFormatVersion is 1.0 or 2.0 (Lambda proxy integrations). Allowed: `1.0, 2.0`
`providerRef`	object	—	ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
`providerRef.name`	string	yes	Name of a cluster-scoped AWSProvider.
`providerRef.region`	string	—	Region overrides the provider's region for this resource only.
`requestParameters`	map<string>	—	RequestParameters are parameter mappings.
`timeoutInMillis`	integer	—	TimeoutInMillis is the custom timeout (50-30000 ms for HTTP APIs).
`vpcLinkRef`	object	—	VPCLinkRef references the APIGatewayV2VpcLink used when connectionType is VPC_LINK.
`vpcLinkRef.name`	string	—	Name of the resource in the same namespace.
`vpcLinkRef.namespace`	string	—	Namespace of the resource.

Status

Field	Type	Required	Description
`apiId`	string	—	APIID is the resolved API identifier the integration was created in.
`awsProvider`	object	—	AWSProvider confirms the account and region this resource was reconciled against.
`awsProvider.accountId`	string	—	AccountID the resource lives in.
`awsProvider.name`	string	—	Name of the AWSProvider used; empty when the operator's own credentials were used.
`awsProvider.region`	string	—	Region the resource lives in (empty for global services).
`conditions`	array<object>	—	Conditions describe the current state of the resource.
`conditions[].lastTransitionTime`	string	yes	lastTransitionTime is the last time the condition transitioned from one status to another.
`conditions[].message`	string	yes	message is a human readable message indicating details about the transition.
`conditions[].observedGeneration`	integer	—	observedGeneration represents the .metadata.generation that the condition was set based upon.
`conditions[].reason`	string	yes	reason contains a programmatic identifier indicating the reason for the condition's last transition.
`conditions[].status`	enum	yes	status of the condition, one of True, False, Unknown. Allowed: `True, False, Unknown`
`conditions[].type`	string	yes	type of condition in CamelCase or in foo.example.com/CamelCase.
`integrationId`	string	—	IntegrationID is the integration identifier.
`lastSyncTime`	string	—	LastSyncTime is when the resource was last successfully reconciled.
`observedGeneration`	integer	—	ObservedGeneration is the most recent .metadata.generation reconciled.

APIGatewayV2Route # GA

APIGatewayV2Route is the Schema for managing API Gateway v2 routes.

kubectl get apigatewayv2routes · example on GitHub

Example

# APIGatewayV2Route — API Gateway v2
# 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/apigatewayv2.html#apigatewayv2route
apiVersion: aws.konfig.io/v1alpha1
kind: APIGatewayV2Route
metadata:
  name: example-apigatewayv2route
  namespace: default
spec:
  apiKeyRequired: false
  apiRef:
    name: example-apigatewayv2route
  authorizationScopes:
  - example
  authorizationType: NONE
  authorizerRef:
    name: example-apigatewayv2route
  integrationRef:
    name: example-apigatewayv2route
  operationName: example-apigatewayv2route
  providerRef:
    name: example-apigatewayv2route
    region: us-east-1
  routeKey: example
  target: example

Spec

Field	Type	Required	Description
`apiKeyRequired`	boolean	—	APIKeyRequired specifies whether an API key is required (WebSocket only).
`apiRef`	object	yes	APIRef references the APIGatewayV2API this route belongs to.
`apiRef.apiId`	string	—	APIID is a direct AWS API Gateway API ID, bypassing CR lookup.
`apiRef.name`	string	—	Name of the API CR in the same namespace.
`authorizationScopes`	array<string>	—	AuthorizationScopes are the OAuth scopes for JWT authorization.
`authorizationType`	enum	—	AuthorizationType is the authorization type for the route. Allowed: `NONE, AWS_IAM, CUSTOM, JWT`
`authorizerRef`	object	—	AuthorizerRef references the APIGatewayV2Authorizer for the route when authorizationType is CUSTOM or JWT.
`authorizerRef.authorizerId`	string	—	AuthorizerID is a direct AWS authorizer ID, bypassing CR lookup.
`authorizerRef.name`	string	—	Name of an APIGatewayV2Authorizer CR in the same namespace.
`integrationRef`	object	—	IntegrationRef references the APIGatewayV2Integration this route targets.
`integrationRef.integrationId`	string	—	IntegrationID is a direct AWS integration ID, bypassing CR lookup.
`integrationRef.name`	string	—	Name of an APIGatewayV2Integration CR in the same namespace.
`operationName`	string	—	OperationName is the operation name for the route.
`providerRef`	object	—	ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
`providerRef.name`	string	yes	Name of a cluster-scoped AWSProvider.
`providerRef.region`	string	—	Region overrides the provider's region for this resource only.
`routeKey`	string	yes	RouteKey is the route key (e.g.
`target`	string	—	Target is a raw route target (e.g.

Status

Field	Type	Required	Description
`apiId`	string	—	APIID is the resolved API identifier the route was created in.
`awsProvider`	object	—	AWSProvider confirms the account and region this resource was reconciled against.
`awsProvider.accountId`	string	—	AccountID the resource lives in.
`awsProvider.name`	string	—	Name of the AWSProvider used; empty when the operator's own credentials were used.
`awsProvider.region`	string	—	Region the resource lives in (empty for global services).
`conditions`	array<object>	—	Conditions describe the current state of the resource.
`conditions[].lastTransitionTime`	string	yes	lastTransitionTime is the last time the condition transitioned from one status to another.
`conditions[].message`	string	yes	message is a human readable message indicating details about the transition.
`conditions[].observedGeneration`	integer	—	observedGeneration represents the .metadata.generation that the condition was set based upon.
`conditions[].reason`	string	yes	reason contains a programmatic identifier indicating the reason for the condition's last transition.
`conditions[].status`	enum	yes	status of the condition, one of True, False, Unknown. Allowed: `True, False, Unknown`
`conditions[].type`	string	yes	type of condition in CamelCase or in foo.example.com/CamelCase.
`lastSyncTime`	string	—	LastSyncTime is when the resource was last successfully reconciled.
`observedGeneration`	integer	—	ObservedGeneration is the most recent .metadata.generation reconciled.
`routeId`	string	—	RouteID is the route identifier.

APIGatewayV2Stage # GA

APIGatewayV2Stage is the Schema for managing API Gateway v2 stages.

kubectl get apigatewayv2stages · example on GitHub

Example

# APIGatewayV2Stage — API Gateway v2
# 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/apigatewayv2.html#apigatewayv2stage
apiVersion: aws.konfig.io/v1alpha1
kind: APIGatewayV2Stage
metadata:
  name: example-apigatewayv2stage
  namespace: default
spec:
  apiRef:
    name: example-apigatewayv2stage
  autoDeploy: false
  defaultRouteSettings:
    detailedMetricsEnabled: true
    throttlingBurstLimit: 1
    throttlingRateLimit: 1
  description: Managed by konfig-konector
  providerRef:
    name: example-apigatewayv2stage
    region: us-east-1
  stageName: example-apigatewayv2stage
  stageVariables:
    environment: dev
    team: platform
  tags:
    environment: dev
    team: platform

Spec

Field	Type	Required	Description
`apiRef`	object	yes	APIRef references the APIGatewayV2API this stage belongs to.
`apiRef.apiId`	string	—	APIID is a direct AWS API Gateway API ID, bypassing CR lookup.
`apiRef.name`	string	—	Name of the API CR in the same namespace.
`autoDeploy`	boolean	—	AutoDeploy enables automatic deployments on API updates.
`defaultRouteSettings`	object	—	DefaultRouteSettings is the default route throttling for the stage.
`defaultRouteSettings.detailedMetricsEnabled`	boolean	—	DetailedMetricsEnabled enables detailed CloudWatch metrics.
`defaultRouteSettings.throttlingBurstLimit`	integer	—	ThrottlingBurstLimit is the throttling burst limit.
`defaultRouteSettings.throttlingRateLimit`	number	—	ThrottlingRateLimit is the throttling rate limit (requests per second).
`description`	string	—	Description of the stage.
`providerRef`	object	—	ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
`providerRef.name`	string	yes	Name of a cluster-scoped AWSProvider.
`providerRef.region`	string	—	Region overrides the provider's region for this resource only.
`stageName`	string	yes	StageName is the name of the stage (e.g.
`stageVariables`	map<string>	—	StageVariables are stage variables (name/value pairs).
`tags`	map<string>	—	Tags are AWS resource tags to apply on creation.

Status

Field	Type	Required	Description
`apiId`	string	—	APIID is the resolved API identifier the stage was created in.
`awsProvider`	object	—	AWSProvider confirms the account and region this resource was reconciled against.
`awsProvider.accountId`	string	—	AccountID the resource lives in.
`awsProvider.name`	string	—	Name of the AWSProvider used; empty when the operator's own credentials were used.
`awsProvider.region`	string	—	Region the resource lives in (empty for global services).
`conditions`	array<object>	—	Conditions describe the current state of the resource.
`conditions[].lastTransitionTime`	string	yes	lastTransitionTime is the last time the condition transitioned from one status to another.
`conditions[].message`	string	yes	message is a human readable message indicating details about the transition.
`conditions[].observedGeneration`	integer	—	observedGeneration represents the .metadata.generation that the condition was set based upon.
`conditions[].reason`	string	yes	reason contains a programmatic identifier indicating the reason for the condition's last transition.
`conditions[].status`	enum	yes	status of the condition, one of True, False, Unknown. Allowed: `True, False, Unknown`
`conditions[].type`	string	yes	type of condition in CamelCase or in foo.example.com/CamelCase.
`lastSyncTime`	string	—	LastSyncTime is when the resource was last successfully reconciled.
`observedGeneration`	integer	—	ObservedGeneration is the most recent .metadata.generation reconciled.
`stageName`	string	—	StageName is the stage name in AWS (also the primary identifier together with the API ID).

APIGatewayV2VpcLink # GA

APIGatewayV2VpcLink is the Schema for managing API Gateway v2 VPC links.

kubectl get apigatewayv2vpclinks · example on GitHub

Example

# APIGatewayV2VpcLink — API Gateway v2
# 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/apigatewayv2.html#apigatewayv2vpclink
apiVersion: aws.konfig.io/v1alpha1
kind: APIGatewayV2VpcLink
metadata:
  name: example-apigatewayv2vpclink
  namespace: default
spec:
  name: example-apigatewayv2vpclink
  providerRef:
    name: example-apigatewayv2vpclink
    region: us-east-1
  securityGroupRefs:
  - name: example-securitygrouprefs
  subnetRefs:
  - name: example-subnetrefs
  tags:
    environment: dev
    team: platform

Spec

Field	Type	Required	Description
`name`	string	yes	Name of the VPC link.
`providerRef`	object	—	ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
`providerRef.name`	string	yes	Name of a cluster-scoped AWSProvider.
`providerRef.region`	string	—	Region overrides the provider's region for this resource only.
`securityGroupRefs`	array<object>	—	SecurityGroupRefs are the security groups for the VPC link.
`securityGroupRefs[].id`	string	—	ID is a direct AWS Security Group ID (e.g.
`securityGroupRefs[].name`	string	—	Name of a SecurityGroup CR in the same namespace.
`subnetRefs`	array<object>	yes	SubnetRefs are the subnets for the VPC link.
`subnetRefs[].id`	string	—	ID is a direct AWS Subnet ID (e.g.
`subnetRefs[].name`	string	—	Name of a Subnet CR in the same namespace.
`tags`	map<string>	—	Tags are AWS resource tags to apply on creation.

Status

Field	Type	Required	Description
`awsProvider`	object	—	AWSProvider confirms the account and region this resource was reconciled against.
`awsProvider.accountId`	string	—	AccountID the resource lives in.
`awsProvider.name`	string	—	Name of the AWSProvider used; empty when the operator's own credentials were used.
`awsProvider.region`	string	—	Region the resource lives in (empty for global services).
`conditions`	array<object>	—	Conditions describe the current state of the resource.
`conditions[].lastTransitionTime`	string	yes	lastTransitionTime is the last time the condition transitioned from one status to another.
`conditions[].message`	string	yes	message is a human readable message indicating details about the transition.
`conditions[].observedGeneration`	integer	—	observedGeneration represents the .metadata.generation that the condition was set based upon.
`conditions[].reason`	string	yes	reason contains a programmatic identifier indicating the reason for the condition's last transition.
`conditions[].status`	enum	yes	status of the condition, one of True, False, Unknown. Allowed: `True, False, Unknown`
`conditions[].type`	string	yes	type of condition in CamelCase or in foo.example.com/CamelCase.
`lastSyncTime`	string	—	LastSyncTime is when the resource was last successfully reconciled.
`observedGeneration`	integer	—	ObservedGeneration is the most recent .metadata.generation reconciled.
`vpcLinkId`	string	—	VPCLinkID is the VPC link identifier.
`vpcLinkStatus`	string	—	VPCLinkStatus is the AWS status of the VPC link (PENDING, AVAILABLE, ...).

ApiGatewayV2ApiGatewayManagedOverrides # CLOUD CONTROL · AWS::ApiGatewayV2::ApiGatewayManagedOverrides

ApiGatewayV2ApiGatewayManagedOverrides manages AWS::ApiGatewayV2::ApiGatewayManagedOverrides through the AWS Cloud Control API.

kubectl get apigatewayv2apigatewaymanagedoverrides · example on GitHub

Example

# ApiGatewayV2ApiGatewayManagedOverrides — API Gateway v2
# 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/apigatewayv2.html#apigatewayv2apigatewaymanagedoverrides
apiVersion: aws.konfig.io/v1alpha1
kind: ApiGatewayV2ApiGatewayManagedOverrides
metadata:
  name: example-apigatewayv2apigatewaymanagedoverrides
  namespace: default
spec:
  apiId: example-id
  integration:
    description: Managed by konfig-konector
    integrationMethod: example
    payloadFormatVersion: '1.0'
    timeoutInMillis: 300
  providerRef:
    name: example-apigatewayv2apigatewaymanagedoverrides
    region: us-east-1
  route:
    authorizationScopes:
    - example
    authorizationType: example
    operationName: example-apigatewayv2apigatewaymanagedoverrides
    target: example
  stage:
    accessLogSettings:
      destinationArn: arn:aws:iam::123456789012:role/example-role
      format: example
    autoDeploy: false
    defaultRouteSettings:
      detailedMetricsEnabled: true
      throttlingBurstLimit: 1
      throttlingRateLimit: 1
    description: Managed by konfig-konector
    routeSettings: {}
    stageVariables:
      environment: dev
      team: platform

Spec

Field	Type	Required	Description
`apiId`	string	yes	The ID of the API for which to override the configuration of API Gateway-managed resources.
`integration`	object	—	Overrides the integration configuration for an API Gateway-managed integration.
`integration.description`	string	—	The description of the integration.
`integration.integrationMethod`	string	—	Specifies the integration's HTTP method type.
`integration.payloadFormatVersion`	string	—	Specifies the format of the payload sent to an integration.
`integration.timeoutInMillis`	integer	—	Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs.
`providerRef`	object	—	ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
`providerRef.name`	string	yes	Name of a cluster-scoped AWSProvider.
`providerRef.region`	string	—	Region overrides the provider's region for this resource only.
`route`	object	—	Overrides the route configuration for an API Gateway-managed route.
`route.authorizationScopes`	array<string>	—	The authorization scopes supported by this route.
`route.authorizationType`	string	—	The authorization type for the route.
`route.authorizerId`	string	—	The identifier of the Authorizer resource to be associated with this route.
`route.operationName`	string	—	The operation name for the route.
`route.target`	string	—	For HTTP integrations, specify a fully qualified URL.
`stage`	object	—	Overrides the stage configuration for an API Gateway-managed stage.
`stage.accessLogSettings`	object	—	Settings for logging access in a stage.
`stage.accessLogSettings.destinationArn`	string	—	The ARN of the CloudWatch Logs log group to receive access logs.
`stage.accessLogSettings.format`	string	—	A single line format of the access logs of data, as specified by selected $context variables.
`stage.autoDeploy`	boolean	—	Specifies whether updates to an API automatically trigger a new deployment.
`stage.defaultRouteSettings`	object	—	The default route settings for the stage.
`stage.defaultRouteSettings.detailedMetricsEnabled`	boolean	—	Specifies whether detailed metrics are enabled.
`stage.defaultRouteSettings.throttlingBurstLimit`	integer	—	Specifies the throttling burst limit.
`stage.defaultRouteSettings.throttlingRateLimit`	number	—	Specifies the throttling rate limit.
`stage.description`	string	—	The description for the API stage.
`stage.routeSettings`	map<string>	—	Route settings for the stage.
`stage.stageVariables`	map<string>	—	A map that defines the stage variables for a Stage.

Status

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

ApiGatewayV2Deployment # CLOUD CONTROL · AWS::ApiGatewayV2::Deployment

ApiGatewayV2Deployment manages AWS::ApiGatewayV2::Deployment through the AWS Cloud Control API.

kubectl get apigatewayv2deployments · example on GitHub

Example

# ApiGatewayV2Deployment — API Gateway v2
# 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/apigatewayv2.html#apigatewayv2deployment
apiVersion: aws.konfig.io/v1alpha1
kind: ApiGatewayV2Deployment
metadata:
  name: example-apigatewayv2deployment
  namespace: default
spec:
  apiId: example-id
  description: Managed by konfig-konector
  providerRef:
    name: example-apigatewayv2deployment
    region: us-east-1
  stageName: example-apigatewayv2deployment

Spec

Field	Type	Required	Description
`apiId`	string	yes	The API identifier.
`description`	string	—	The description for the deployment resource.
`providerRef`	object	—	ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
`providerRef.name`	string	yes	Name of a cluster-scoped AWSProvider.
`providerRef.region`	string	—	Region overrides the provider's region for this resource only.
`stageName`	string	—	The name of an existing stage to associate with the deployment.

Status

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

ApiGatewayV2IntegrationResponse # CLOUD CONTROL · AWS::ApiGatewayV2::IntegrationResponse

ApiGatewayV2IntegrationResponse manages AWS::ApiGatewayV2::IntegrationResponse through the AWS Cloud Control API.

kubectl get apigatewayv2integrationresponses · example on GitHub

Example

# ApiGatewayV2IntegrationResponse — API Gateway v2
# 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/apigatewayv2.html#apigatewayv2integrationresponse
apiVersion: aws.konfig.io/v1alpha1
kind: ApiGatewayV2IntegrationResponse
metadata:
  name: example-apigatewayv2integrationresponse
  namespace: default
spec:
  apiId: example-id
  contentHandlingStrategy: example
  integrationId: example-id
  integrationResponseKey: example
  providerRef:
    name: example-apigatewayv2integrationresponse
    region: us-east-1
  templateSelectionExpression: example

Spec

Field	Type	Required	Description
`apiId`	string	yes	The API identifier.
`contentHandlingStrategy`	string	—	Supported only for WebSocket APIs.
`integrationId`	string	yes	The integration ID.
`integrationResponseKey`	string	yes	The integration response key.
`providerRef`	object	—	ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
`providerRef.name`	string	yes	Name of a cluster-scoped AWSProvider.
`providerRef.region`	string	—	Region overrides the provider's region for this resource only.
`responseParameters`	object	—	A key-value map specifying response parameters that are passed to the method response from the backend.
`responseTemplates`	object	—	The collection of response templates for the integration response as a string-to-string map of key-value pairs.
`templateSelectionExpression`	string	—	The template selection expression for the integration response.

Status

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

ApiGatewayV2Model # CLOUD CONTROL · AWS::ApiGatewayV2::Model

ApiGatewayV2Model manages AWS::ApiGatewayV2::Model through the AWS Cloud Control API.

kubectl get apigatewayv2models · example on GitHub

Example

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

Spec

Field	Type	Required	Description
`apiId`	string	yes	The API identifier.
`contentType`	string	—	The content-type for the model, for example, "application/json".
`description`	string	—	The description of the model.
`name`	string	yes	The name of the model.
`providerRef`	object	—	ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
`providerRef.name`	string	yes	Name of a cluster-scoped AWSProvider.
`providerRef.region`	string	—	Region overrides the provider's region for this resource only.
`schema`	object	yes	The schema for the model.

Status

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

ApiGatewayV2PortalProduct # CLOUD CONTROL · AWS::ApiGatewayV2::PortalProduct

ApiGatewayV2PortalProduct manages AWS::ApiGatewayV2::PortalProduct through the AWS Cloud Control API.

kubectl get apigatewayv2portalproducts · example on GitHub

Example

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

Spec

Field	Type	Required	Description
`description`	string	—	A description of the portal product.
`displayName`	string	yes	The name of the portal product as it appears in a published portal.
`providerRef`	object	—	ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
`providerRef.name`	string	yes	Name of a cluster-scoped AWSProvider.
`providerRef.region`	string	—	Region overrides the provider's region for this resource only.
`tags`	array<object>	—	The collection of tags associated with the portal product.
`tags[].key`	string	yes
`tags[].value`	string	yes

Status

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

ApiGatewayV2RouteResponse # CLOUD CONTROL · AWS::ApiGatewayV2::RouteResponse

ApiGatewayV2RouteResponse manages AWS::ApiGatewayV2::RouteResponse through the AWS Cloud Control API.

kubectl get apigatewayv2routeresponses · example on GitHub

Example

# ApiGatewayV2RouteResponse — API Gateway v2
# 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/apigatewayv2.html#apigatewayv2routeresponse
apiVersion: aws.konfig.io/v1alpha1
kind: ApiGatewayV2RouteResponse
metadata:
  name: example-apigatewayv2routeresponse
  namespace: default
spec:
  apiId: example-id
  modelSelectionExpression: example
  providerRef:
    name: example-apigatewayv2routeresponse
    region: us-east-1
  routeId: example-id
  routeResponseKey: example

Spec

Field	Type	Required	Description
`apiId`	string	yes	The API identifier.
`modelSelectionExpression`	string	—	The model selection expression for the route response.
`providerRef`	object	—	ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
`providerRef.name`	string	yes	Name of a cluster-scoped AWSProvider.
`providerRef.region`	string	—	Region overrides the provider's region for this resource only.
`responseModels`	object	—	The response models for the route response.
`responseParameters`	object	—	The route response parameters.
`routeId`	string	yes	The route ID.
`routeResponseKey`	string	yes	The route response key.

Status

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

ApiGatewayV2RoutingRule # CLOUD CONTROL · AWS::ApiGatewayV2::RoutingRule

ApiGatewayV2RoutingRule manages AWS::ApiGatewayV2::RoutingRule through the AWS Cloud Control API.

kubectl get apigatewayv2routingrules · example on GitHub

Example

# ApiGatewayV2RoutingRule — API Gateway v2
# 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/apigatewayv2.html#apigatewayv2routingrule
apiVersion: aws.konfig.io/v1alpha1
kind: ApiGatewayV2RoutingRule
metadata:
  name: example-apigatewayv2routingrule
  namespace: default
spec:
  actions:
  - invokeApi:
      apiId: example-id
      stage: example
      stripBasePath: false
  conditions:
  - matchBasePaths:
      anyOf:
      - example
    matchHeaders:
      anyOf:
      - header: example
        valueGlob: example
  domainNameArn: arn:aws:iam::123456789012:role/example-role
  priority: 1
  providerRef:
    name: example-apigatewayv2routingrule
    region: us-east-1

Spec

Field	Type	Required	Description
`actions`	array<object>	yes	The resulting action based on matching a routing rules condition.
`actions[].invokeApi`	object	yes	Represents an InvokeApi action.
`actions[].invokeApi.apiId`	string	yes	The API identifier of the target API.
`actions[].invokeApi.stage`	string	yes	The name of the target stage.
`actions[].invokeApi.stripBasePath`	boolean	—	The strip base path setting.
`conditions`	array<object>	yes	The conditions of the routing rule.
`conditions[].matchBasePaths`	object	—	The base path to be matched.
`conditions[].matchBasePaths.anyOf`	array<string>	yes	The string of the case sensitive base path to be matched.
`conditions[].matchHeaders`	object	—	The headers to be matched.
`conditions[].matchHeaders.anyOf`	array<object>	yes	The header name and header value glob to be matched.
`conditions[].matchHeaders.anyOf[].header`	string	yes	The case insensitive header name to be matched.
`conditions[].matchHeaders.anyOf[].valueGlob`	string	yes	The case sensitive header glob value to be matched against entire header value.
`domainNameArn`	string	yes	The ARN of the domain name.
`priority`	integer	yes	The order in which API Gateway evaluates a rule.
`providerRef`	object	—	ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
`providerRef.name`	string	yes	Name of a cluster-scoped AWSProvider.
`providerRef.region`	string	—	Region overrides the provider's region for this resource only.

Status

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