Amplify
4 resource kinds. Generated from the operator's CRD schemas.
API Group:
aws.konfig.io/v1alpha1
AmplifyApp # CLOUD CONTROL · AWS::Amplify::App
AmplifyApp manages AWS::Amplify::App through the AWS Cloud Control API.
kubectl get amplifyapps · example on GitHub
Example
# AmplifyApp — Amplify
# 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/amplify.html#amplifyapp
apiVersion: aws.konfig.io/v1alpha1
kind: AmplifyApp
metadata:
name: example-amplifyapp
namespace: default
spec:
accessToken: example
autoBranchCreationConfig:
autoBranchCreationPatterns:
- example
basicAuthConfig:
enableBasicAuth: true
password: example
username: example-amplifyapp
buildSpec: example
enableAutoBranchCreation: true
enableAutoBuild: true
enablePerformanceMode: true
enablePullRequestPreview: true
environmentVariables:
- name: example-amplifyapp
value: example
framework: example
pullRequestEnvironmentName: example-amplifyapp
stage: EXPERIMENTAL
basicAuthConfig:
enableBasicAuth: true
password: example
username: example-amplifyapp
buildSpec: example
cacheConfig:
type: AMPLIFY_MANAGED
computeRoleArn: arn:aws:iam::123456789012:role/example-role
customHeaders: example
customRules:
- condition: example
source: example
status: example
target: example
description: Managed by konfig-konector
enableBranchAutoDeletion: true
environmentVariables:
- name: example-amplifyapp
value: example
iamServiceRole: example
jobConfig:
buildComputeType: STANDARD_8GB
name: example-amplifyapp
oauthToken: example
platform: WEB
providerRef:
name: example-amplifyapp
region: us-east-1
repository: example
tags:
- key: example
value: example
Spec
| Field | Type | Required | Description |
|---|---|---|---|
accessToken | string | — | |
autoBranchCreationConfig | object | — | AmplifyAppAutoBranchCreationConfig is a nested property type of AWS::Amplify::App. |
autoBranchCreationConfig.autoBranchCreationPatterns | array<string> | — | |
autoBranchCreationConfig.basicAuthConfig | object | — | AmplifyAppBasicAuthConfig is a nested property type of AWS::Amplify::App. |
autoBranchCreationConfig.basicAuthConfig.enableBasicAuth | boolean | — | |
autoBranchCreationConfig.basicAuthConfig.password | string | — | |
autoBranchCreationConfig.basicAuthConfig.username | string | — | |
autoBranchCreationConfig.buildSpec | string | — | |
autoBranchCreationConfig.enableAutoBranchCreation | boolean | — | |
autoBranchCreationConfig.enableAutoBuild | boolean | — | |
autoBranchCreationConfig.enablePerformanceMode | boolean | — | |
autoBranchCreationConfig.enablePullRequestPreview | boolean | — | |
autoBranchCreationConfig.environmentVariables | array<object> | — | |
autoBranchCreationConfig.environmentVariables[].name | string | yes | |
autoBranchCreationConfig.environmentVariables[].value | string | yes | |
autoBranchCreationConfig.framework | string | — | |
autoBranchCreationConfig.pullRequestEnvironmentName | string | — | |
autoBranchCreationConfig.stage | enum | — | Allowed: EXPERIMENTAL, BETA, PULL_REQUEST, PRODUCTION, DEVELOPMENT |
basicAuthConfig | object | — | AmplifyAppBasicAuthConfig is a nested property type of AWS::Amplify::App. |
basicAuthConfig.enableBasicAuth | boolean | — | |
basicAuthConfig.password | string | — | |
basicAuthConfig.username | string | — | |
buildSpec | string | — | |
cacheConfig | object | — | AmplifyAppCacheConfig is a nested property type of AWS::Amplify::App. |
cacheConfig.type | enum | — | Allowed: AMPLIFY_MANAGED, AMPLIFY_MANAGED_NO_COOKIES |
computeRoleArn | string | — | |
customHeaders | string | — | |
customRules | array<object> | — | |
customRules[].condition | string | — | |
customRules[].source | string | yes | |
customRules[].status | string | — | |
customRules[].target | string | yes | |
description | string | — | |
enableBranchAutoDeletion | boolean | — | |
environmentVariables | array<object> | — | |
environmentVariables[].name | string | yes | |
environmentVariables[].value | string | yes | |
iamServiceRole | string | — | |
jobConfig | object | — | AmplifyAppJobConfig is a nested property type of AWS::Amplify::App. |
jobConfig.buildComputeType | enum | yes | Allowed: STANDARD_8GB, LARGE_16GB, XLARGE_72GB |
name | string | yes | |
oauthToken | string | — | |
platform | enum | — | Allowed: WEB, WEB_DYNAMIC, WEB_COMPUTE |
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. |
repository | string | — | |
tags | array<object> | — | |
tags[].key | string | yes | |
tags[].value | string | yes |
Status
| Field | Type | Required | Description |
|---|---|---|---|
appId | string | — | Read-only: reported by AWS after creation. |
appName | string | — | Read-only: reported by AWS after creation. |
arn | string | — | Read-only: reported by AWS after creation. |
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. |
defaultDomain | 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. |
AmplifyBranch # CLOUD CONTROL · AWS::Amplify::Branch
AmplifyBranch manages AWS::Amplify::Branch through the AWS Cloud Control API.
kubectl get amplifybranches · example on GitHub
Example
# AmplifyBranch — Amplify
# 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/amplify.html#amplifybranch
apiVersion: aws.konfig.io/v1alpha1
kind: AmplifyBranch
metadata:
name: example-amplifybranch
namespace: default
spec:
appId: example-id
backend:
stackArn: arn:aws:iam::123456789012:role/example-role
basicAuthConfig:
enableBasicAuth: true
password: example
username: example-amplifybranch
branchName: example-amplifybranch
buildSpec: example
computeRoleArn: arn:aws:iam::123456789012:role/example-role
description: Managed by konfig-konector
enableAutoBuild: true
enablePerformanceMode: true
enablePullRequestPreview: true
enableSkewProtection: true
environmentVariables:
- name: example-amplifybranch
value: example
framework: example
providerRef:
name: example-amplifybranch
region: us-east-1
pullRequestEnvironmentName: example-amplifybranc
stage: EXPERIMENTAL
tags:
- key: example
value: example
Spec
| Field | Type | Required | Description |
|---|---|---|---|
appId | string | yes | Create-only in AWS: changing it requires replacing the resource. |
backend | object | — | AmplifyBranchBackend is a nested property type of AWS::Amplify::Branch. |
backend.stackArn | string | — | |
basicAuthConfig | object | — | AmplifyBranchBasicAuthConfig is a nested property type of AWS::Amplify::Branch. |
basicAuthConfig.enableBasicAuth | boolean | — | |
basicAuthConfig.password | string | yes | |
basicAuthConfig.username | string | yes | |
branchName | string | yes | Create-only in AWS: changing it requires replacing the resource. |
buildSpec | string | — | |
computeRoleArn | string | — | |
description | string | — | |
enableAutoBuild | boolean | — | |
enablePerformanceMode | boolean | — | |
enablePullRequestPreview | boolean | — | |
enableSkewProtection | boolean | — | |
environmentVariables | array<object> | — | |
environmentVariables[].name | string | yes | |
environmentVariables[].value | string | yes | |
framework | string | — | |
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. |
pullRequestEnvironmentName | string | — | |
stage | enum | — | Allowed: EXPERIMENTAL, BETA, PULL_REQUEST, PRODUCTION, DEVELOPMENT |
tags | array<object> | — | |
tags[].key | string | yes | |
tags[].value | string | yes |
Status
| Field | Type | Required | Description |
|---|---|---|---|
arn | string | — | Read-only: reported by AWS after creation. |
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. |
AmplifyDomain # CLOUD CONTROL · AWS::Amplify::Domain
AmplifyDomain manages AWS::Amplify::Domain through the AWS Cloud Control API.
kubectl get amplifydomains · example on GitHub
Example
# AmplifyDomain — Amplify
# 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/amplify.html#amplifydomain
apiVersion: aws.konfig.io/v1alpha1
kind: AmplifyDomain
metadata:
name: example-amplifydomain
namespace: default
spec:
appId: example-id
autoSubDomainCreationPatterns:
- example
autoSubDomainIAMRole: example
certificateSettings:
certificateType: AMPLIFY_MANAGED
customCertificateArn: arn:aws:iam::123456789012:role/example-role
domainName: example-amplifydomain
enableAutoSubDomain: true
providerRef:
name: example-amplifydomain
region: us-east-1
subDomainSettings:
- branchName: example-amplifydomain
prefix: example
Spec
| Field | Type | Required | Description |
|---|---|---|---|
appId | string | yes | Create-only in AWS: changing it requires replacing the resource. |
autoSubDomainCreationPatterns | array<string> | — | |
autoSubDomainIAMRole | string | — | |
certificateSettings | object | — | AmplifyDomainCertificateSettings is a nested property type of AWS::Amplify::Domain. |
certificateSettings.certificateType | enum | — | Allowed: AMPLIFY_MANAGED, CUSTOM |
certificateSettings.customCertificateArn | string | — | |
domainName | string | yes | Create-only in AWS: changing it requires replacing the resource. |
enableAutoSubDomain | boolean | — | |
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. |
subDomainSettings | array<object> | yes | |
subDomainSettings[].branchName | string | yes | |
subDomainSettings[].prefix | string | yes |
Status
| Field | Type | Required | Description |
|---|---|---|---|
arn | string | — | Read-only: reported by AWS after creation. |
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). |
certificate | object | — | Read-only: reported by AWS after creation. |
certificate.certificateArn | string | — | |
certificate.certificateType | enum | — | Allowed: AMPLIFY_MANAGED, CUSTOM |
certificate.certificateVerificationDNSRecord | string | — | |
certificateRecord | string | — | Read-only: reported by AWS after creation. |
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. |
domainStatus | 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. |
statusReason | string | — | Read-only: reported by AWS after creation. |
updateStatus | string | — | Read-only: reported by AWS after creation. |
AmplifyWebhook # CLOUD CONTROL · AWS::Amplify::Webhook
AmplifyWebhook manages AWS::Amplify::Webhook through the AWS Cloud Control API.
kubectl get amplifywebhooks · example on GitHub
Example
# AmplifyWebhook — Amplify
# 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/amplify.html#amplifywebhook
apiVersion: aws.konfig.io/v1alpha1
kind: AmplifyWebhook
metadata:
name: example-amplifywebhook
namespace: default
spec:
branchName: example-amplifywebhook
description: Managed by konfig-konector
providerRef:
name: example-amplifywebhook
region: us-east-1
tags:
- key: example
value: example
Spec
| Field | Type | Required | Description |
|---|---|---|---|
appId | string | — | The unique ID for an Amplify app. |
branchName | string | yes | The name for a branch that is part of an Amplify app. |
description | string | — | The description for a webhook. |
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> | — | Tags for the webhook. |
tags[].key | string | yes | |
tags[].value | string | yes |
Status
| Field | Type | Required | Description |
|---|---|---|---|
arn | string | — | The Amazon Resource Name (ARN) for the webhook. |
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. |
webhookId | string | — | The unique ID for a webhook. |
webhookUrl | string | — | The URL of the webhook. |