CodeStar Connections
3 resource kinds. Generated from the operator's CRD schemas.
API Group:
aws.konfig.io/v1alpha1
CodeStarConnectionsConnection # CLOUD CONTROL · AWS::CodeStarConnections::Connection
CodeStarConnectionsConnection manages AWS::CodeStarConnections::Connection through the AWS Cloud Control API.
kubectl get codestarconnectionsconnections · example on GitHub
Example
# CodeStarConnectionsConnection — CodeStar Connections
# 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/codestarconnections.html#codestarconnectionsconnection
apiVersion: aws.konfig.io/v1alpha1
kind: CodeStarConnectionsConnection
metadata:
name: example-codestarconnectionsconnection
namespace: default
spec:
connectionName: example-codestarconnectionsconne
hostArn: arn:aws:iam::123456789012:role/example-role
providerRef:
name: example-codestarconnectionsconnection
region: us-east-1
providerType: example
tags:
- key: example
value: example
Spec
| Field | Type | Required | Description |
|---|---|---|---|
connectionName | string | yes | The name of the connection. |
hostArn | string | — | The host arn configured to represent the infrastructure where your third-party provider is installed. |
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. |
providerType | string | — | The name of the external provider where your third-party code repository is configured. |
tags | array<object> | — | Specifies the tags applied to a connection. |
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. |
connectionArn | string | — | The Amazon Resource Name (ARN) of the connection. |
connectionStatus | string | — | The current status of the connection. |
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. |
ownerAccountId | string | — | The name of the external provider where your third-party code repository is configured. |
requestToken | string | — | RequestToken tracks an in-flight asynchronous operation. |
CodeStarConnectionsRepositoryLink # CLOUD CONTROL · AWS::CodeStarConnections::RepositoryLink
CodeStarConnectionsRepositoryLink manages AWS::CodeStarConnections::RepositoryLink through the AWS Cloud Control API.
kubectl get codestarconnectionsrepositorylinks · example on GitHub
Example
# CodeStarConnectionsRepositoryLink — CodeStar Connections
# 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/codestarconnections.html#codestarconnectionsrepositorylink
apiVersion: aws.konfig.io/v1alpha1
kind: CodeStarConnectionsRepositoryLink
metadata:
name: example-codestarconnectionsrepositorylink
namespace: default
spec:
connectionArn: arn:aws:iam::123456789012:role/example-role
encryptionKeyArn: arn:aws:iam::123456789012:role/example-role
ownerId: example-id
providerRef:
name: example-codestarconnectionsrepositorylink
region: us-east-1
repositoryName: example-codestarconnectionsrepositorylink
tags:
- key: example
value: example
Spec
| Field | Type | Required | Description |
|---|---|---|---|
connectionArn | string | yes | The Amazon Resource Name (ARN) of the CodeStarConnection. |
encryptionKeyArn | string | — | The ARN of the KMS key that the customer can optionally specify to use to encrypt RepositoryLink properties. |
ownerId | string | yes | the ID of the entity that owns the repository. |
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. |
repositoryName | string | yes | The repository for which the link is being created. |
tags | array<object> | — | Specifies the tags applied to a RepositoryLink. |
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. |
lastSyncTime | string | — | |
observedGeneration | integer | — | |
operation | string | — | Operation is the in-flight operation (CREATE, UPDATE, DELETE). |
operationStatus | string | — | OperationStatus is the last reported operation status. |
providerType | enum | — | The name of the external provider where your third-party code repository is configured. Allowed: GitHub, Bitbucket, GitHubEnterprise, GitLab, GitLabSelfManaged |
repositoryLinkArn | string | — | A unique Amazon Resource Name (ARN) to designate the repository link. |
repositoryLinkId | string | — | A UUID that uniquely identifies the RepositoryLink. |
requestToken | string | — | RequestToken tracks an in-flight asynchronous operation. |
CodeStarConnectionsSyncConfiguration # CLOUD CONTROL · AWS::CodeStarConnections::SyncConfiguration
CodeStarConnectionsSyncConfiguration manages AWS::CodeStarConnections::SyncConfiguration through the AWS Cloud Control API.
kubectl get codestarconnectionssyncconfigurations · example on GitHub
Example
# CodeStarConnectionsSyncConfiguration — CodeStar Connections
# 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/codestarconnections.html#codestarconnectionssyncconfiguration
apiVersion: aws.konfig.io/v1alpha1
kind: CodeStarConnectionsSyncConfiguration
metadata:
name: example-codestarconnectionssyncconfiguration
namespace: default
spec:
branch: example
configFile: example
providerRef:
name: example-codestarconnectionssyncconfiguration
region: us-east-1
publishDeploymentStatus: ENABLED
repositoryLinkId: example-id
resourceName: example-codestarconnectionssyncconfiguration
roleArn: arn:aws:iam::123456789012:role/example-role
syncType: example
triggerResourceUpdateOn: ANY_CHANGE
Spec
| Field | Type | Required | Description |
|---|---|---|---|
branch | string | yes | The name of the branch of the repository from which resources are to be synchronized, |
configFile | string | yes | The source provider repository path of the sync configuration file of the respective SyncType. |
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. |
publishDeploymentStatus | enum | — | Whether to enable or disable publishing of deployment status to source providers. Allowed: ENABLED, DISABLED |
repositoryLinkId | string | yes | A UUID that uniquely identifies the RepositoryLink that the SyncConfig is associated with. |
resourceName | string | yes | The name of the resource that is being synchronized to the repository. |
roleArn | string | yes | The IAM Role that allows AWS to update CloudFormation stacks based on content in the specified repository. |
syncType | string | yes | The type of resource synchronization service that is to be configured, for example, CFN_STACK_SYNC. |
triggerResourceUpdateOn | enum | — | When to trigger Git sync to begin the stack update. Allowed: ANY_CHANGE, FILE_CHANGE |
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. |
ownerId | string | — | the ID of the entity that owns the repository. |
providerType | enum | — | The name of the external provider where your third-party code repository is configured. Allowed: GitHub, Bitbucket, GitHubEnterprise, GitLab, GitLabSelfManaged |
repositoryName | string | — | The name of the repository that is being synced to. |
requestToken | string | — | RequestToken tracks an in-flight asynchronous operation. |