App Runner

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

API Group: aws.konfig.io/v1alpha1

AppRunnerAutoScaling # GA

AppRunnerAutoScaling is the Schema for managing AWS App Runner auto scaling configurations.

kubectl get apprunnerautoscalings · example on GitHub

Example

# AppRunnerAutoScaling — App Runner
# 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/apprunner.html#apprunnerautoscaling
apiVersion: aws.konfig.io/v1alpha1
kind: AppRunnerAutoScaling
metadata:
  name: example-apprunnerautoscaling
  namespace: default
spec:
  maxConcurrency: 1
  maxSize: 1
  minSize: 1
  name: example-apprunnerautoscaling
  providerRef:
    name: example-apprunnerautoscaling
    region: us-east-1
  tags:
    environment: dev
    team: platform

Spec

FieldTypeRequiredDescription
maxConcurrencyinteger—MaxConcurrency is the maximum concurrent requests per instance.
maxSizeinteger—MaxSize is the maximum number of instances.
minSizeinteger—MinSize is the minimum number of provisioned instances.
namestringyesName of the auto scaling configuration.
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.

Status

FieldTypeRequiredDescription
autoScalingConfigurationArnstring—AutoScalingConfigurationARN is the ARN of the configuration revision.
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.
revisioninteger—Revision is the created configuration revision.

AppRunnerObservabilityConfiguration # CLOUD CONTROL · AWS::AppRunner::ObservabilityConfiguration

AppRunnerObservabilityConfiguration manages AWS::AppRunner::ObservabilityConfiguration through the AWS Cloud Control API.

kubectl get apprunnerobservabilityconfigurations · example on GitHub

Example

# AppRunnerObservabilityConfiguration — App Runner
# 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/apprunner.html#apprunnerobservabilityconfiguration
apiVersion: aws.konfig.io/v1alpha1
kind: AppRunnerObservabilityConfiguration
metadata:
  name: example-apprunnerobservabilityconfiguration
  namespace: default
spec:
  observabilityConfigurationName: example-apprunnerobservabilityco
  providerRef:
    name: example-apprunnerobservabilityconfiguration
    region: us-east-1
  tags:
  - key: example
    value: example
  traceConfiguration:
    vendor: AWSXRAY

Spec

FieldTypeRequiredDescription
observabilityConfigurationNamestring—A name for the observability configuration.
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>—A list of metadata items that you can associate with your observability configuration resource.
tags[].keystringyes
tags[].valuestringyes
traceConfigurationobject—The configuration of the tracing feature within this observability configuration.
traceConfiguration.vendorenumyesThe implementation provider chosen for tracing App Runner services. Allowed: AWSXRAY

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—
latestboolean—It's set to true for the configuration with the highest Revision among all configurations that share the same Name.
observabilityConfigurationArnstring—The Amazon Resource Name (ARN) of this ObservabilityConfiguration Read-only: reported by AWS after creation.
observabilityConfigurationRevisioninteger—The revision of this observability configuration.
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.

AppRunnerService # GA

AppRunnerService is the Schema for managing AWS App Runner services.

kubectl get apprunnerservices · example on GitHub

Example

# AppRunnerService — App Runner
# 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/apprunner.html#apprunnerservice
apiVersion: aws.konfig.io/v1alpha1
kind: AppRunnerService
metadata:
  name: example-apprunnerservice
  namespace: default
spec:
  healthCheckConfiguration:
    healthyThreshold: 1
    interval: 1
    path: example
    protocol: TCP
    timeout: 1
    unhealthyThreshold: 1
  instanceConfiguration:
    cpu: example
    instanceRoleArn: arn:aws:iam::123456789012:role/example-role
    instanceRoleRef:
      name: example-instancerole
    memory: example
  providerRef:
    name: example-apprunnerservice
    region: us-east-1
  serviceName: example-apprunnerservice
  sourceConfiguration:
    authenticationConfiguration:
      accessRoleArn: arn:aws:iam::123456789012:role/example-role
      accessRoleRef:
        name: example-accessrole
    autoDeploymentsEnabled: true
    imageRepository:
      imageConfiguration:
        port: example
        startCommand: example
      imageIdentifier: example
      imageRepositoryType: ECR
  tags:
    environment: dev
    team: platform

Spec

FieldTypeRequiredDescription
healthCheckConfigurationobject—HealthCheckConfiguration configures the service health check.
healthCheckConfiguration.healthyThresholdinteger—HealthyThreshold is consecutive successes before healthy.
healthCheckConfiguration.intervalinteger—Interval between health checks in seconds.
healthCheckConfiguration.pathstring—Path health check requests are sent to (HTTP only).
healthCheckConfiguration.protocolenum—Protocol used for health checks (TCP or HTTP). Allowed: TCP, HTTP
healthCheckConfiguration.timeoutinteger—Timeout for a health check response in seconds.
healthCheckConfiguration.unhealthyThresholdinteger—UnhealthyThreshold is consecutive failures before unhealthy.
instanceConfigurationobject—InstanceConfiguration configures service instances.
instanceConfiguration.cpustring—CPU units reserved for each instance (e.g.
instanceConfiguration.instanceRoleArnstring—InstanceRoleArn is a direct IAM role ARN the service instances assume.
instanceConfiguration.instanceRoleRefobject—InstanceRoleRef references an IAMRole CR for the instance role.
instanceConfiguration.instanceRoleRef.arnstring—ARN is a direct AWS IAM role ARN.
instanceConfiguration.instanceRoleRef.namestring—Name of an IAMRole CR in the same namespace.
instanceConfiguration.instanceRoleRef.namespacestring—Namespace of the IAMRole CR.
instanceConfiguration.memorystring—Memory reserved for each instance (e.g.
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.
serviceNamestringyesServiceName is the name of the service.
sourceConfigurationobjectyesSourceConfiguration describes the source deployed to the service.
sourceConfiguration.authenticationConfigurationobject—AuthenticationConfiguration configures source access.
sourceConfiguration.authenticationConfiguration.accessRoleArnstring—AccessRoleArn is a direct IAM role ARN granting App Runner access to the ECR image (required for private ECR).
sourceConfiguration.authenticationConfiguration.accessRoleRefobject—AccessRoleRef references an IAMRole CR for the access role.
sourceConfiguration.authenticationConfiguration.accessRoleRef.arnstring—ARN is a direct AWS IAM role ARN.
sourceConfiguration.authenticationConfiguration.accessRoleRef.namestring—Name of an IAMRole CR in the same namespace.
sourceConfiguration.authenticationConfiguration.accessRoleRef.namespacestring—Namespace of the IAMRole CR.
sourceConfiguration.autoDeploymentsEnabledboolean—AutoDeploymentsEnabled starts a deployment on each image change.
sourceConfiguration.imageRepositoryobjectyesImageRepository describes the source image repository.
sourceConfiguration.imageRepository.imageConfigurationobject—ImageConfiguration configures how the image runs.
sourceConfiguration.imageRepository.imageConfiguration.portstring—Port the application listens on in the container.
sourceConfiguration.imageRepository.imageConfiguration.runtimeEnvironmentVariablesmap<string>—RuntimeEnvironmentVariables available to the running service.
sourceConfiguration.imageRepository.imageConfiguration.startCommandstring—StartCommand overrides the image's default start command.
sourceConfiguration.imageRepository.imageIdentifierstringyesImageIdentifier is the image name (ECR) or full URI (ECR Public).
sourceConfiguration.imageRepository.imageRepositoryTypeenumyesImageRepositoryType is the repository provider. Allowed: ECR, ECR_PUBLIC
tagsmap<string>—Tags are AWS resource tags to apply.

Status

FieldTypeRequiredDescription
awsProviderobject—AWSProvider confirms the account and region this resource was reconciled against.
awsProvider.accountIdstring—AccountID the resource lives in.
awsProvider.namestring—Name of the AWSProvider used; empty when the operator's own credentials were used.
awsProvider.regionstring—Region the resource lives in (empty for global services).
conditionsarray<object>—Conditions describe the current state of the resource.
conditions[].lastTransitionTimestringyeslastTransitionTime is the last time the condition transitioned from one status to another.
conditions[].messagestringyesmessage is a human readable message indicating details about the transition.
conditions[].observedGenerationinteger—observedGeneration represents the .metadata.generation that the condition was set based upon.
conditions[].reasonstringyesreason contains a programmatic identifier indicating the reason for the condition's last transition.
conditions[].statusenumyesstatus of the condition, one of True, False, Unknown. Allowed: True, False, Unknown
conditions[].typestringyestype of condition in CamelCase or in foo.example.com/CamelCase.
lastSyncTimestring—LastSyncTime is when the resource was last successfully reconciled.
observedGenerationinteger—ObservedGeneration is the most recent .metadata.generation reconciled.
serviceArnstring—ServiceARN is the ARN of the App Runner service.
serviceIdstring—ServiceID is the App Runner generated ID of the service.
serviceUrlstring—ServiceURL is the subdomain URL of the running service.
statusstring—Status is the current service state (e.g.

AppRunnerVpcConnector # CLOUD CONTROL · AWS::AppRunner::VpcConnector

AppRunnerVpcConnector manages AWS::AppRunner::VpcConnector through the AWS Cloud Control API.

kubectl get apprunnervpcconnectors · example on GitHub

Example

# AppRunnerVpcConnector — App Runner
# 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/apprunner.html#apprunnervpcconnector
apiVersion: aws.konfig.io/v1alpha1
kind: AppRunnerVpcConnector
metadata:
  name: example-apprunnervpcconnector
  namespace: default
spec:
  providerRef:
    name: example-apprunnervpcconnector
    region: us-east-1
  securityGroups:
  - example
  subnets:
  - example
  tags:
  - key: example
    value: example
  vpcConnectorName: example-apprunnervpcconnector

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.
securityGroupsarray<string>—A list of IDs of security groups that App Runner should use for access to AWS resources under the specified subnets.
subnetsarray<string>yesA list of IDs of subnets that App Runner should use when it associates your service with a custom Amazon VPC.
tagsarray<object>—A list of metadata items that you can associate with your VPC connector resource.
tags[].keystringyes
tags[].valuestringyes
vpcConnectorNamestring—A name for the VPC connector.

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.
vpcConnectorArnstring—The Amazon Resource Name (ARN) of this VPC connector.
vpcConnectorRevisioninteger—The revision of this VPC connector.

AppRunnerVpcIngressConnection # CLOUD CONTROL · AWS::AppRunner::VpcIngressConnection

AppRunnerVpcIngressConnection manages AWS::AppRunner::VpcIngressConnection through the AWS Cloud Control API.

kubectl get apprunnervpcingressconnections · example on GitHub

Example

# AppRunnerVpcIngressConnection — App Runner
# 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/apprunner.html#apprunnervpcingressconnection
apiVersion: aws.konfig.io/v1alpha1
kind: AppRunnerVpcIngressConnection
metadata:
  name: example-apprunnervpcingressconnection
  namespace: default
spec:
  ingressVpcConfiguration:
    vpcEndpointId: example-id
    vpcId: vpc-0abc12def3456789
  providerRef:
    name: example-apprunnervpcingressconnection
    region: us-east-1
  serviceArn: arn:aws:iam::123456789012:role/example-role
  tags:
  - key: example
    value: example
  vpcIngressConnectionName: example-apprunnervpcingressconnection

Spec

FieldTypeRequiredDescription
ingressVpcConfigurationobjectyesAppRunnerVpcIngressConnectionIngressVpcConfiguration is a nested property type of AWS::AppRunner::VpcIngressConnection.
ingressVpcConfiguration.vpcEndpointIdstringyesThe ID of the VPC endpoint that your App Runner service connects to.
ingressVpcConfiguration.vpcIdstringyesThe ID of the VPC that the VPC endpoint is used in.
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.
serviceArnstringyesThe Amazon Resource Name (ARN) of the service.
tagsarray<object>—Create-only in AWS: changing it requires replacing the resource.
tags[].keystringyes
tags[].valuestringyes
vpcIngressConnectionNamestring—The customer-provided Vpc Ingress Connection name.

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.
domainNamestring—The Domain name associated with the VPC Ingress Connection.
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.
statusenum—The current status of the VpcIngressConnection. Allowed: AVAILABLE, PENDING_CREATION, PENDING_UPDATE, PENDING_DELETION, FAILED_CREATION, FAILED_UPDATE, FAILED_DELETION, DELETED
vpcIngressConnectionArnstring—The Amazon Resource Name (ARN) of the VpcIngressConnection.