CodePipeline

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

API Group: aws.konfig.io/v1alpha1

CodePipeline # GA

CodePipeline is the Schema for managing AWS CodePipeline pipelines.

kubectl get codepipelines · example on GitHub

Example

# CodePipeline — CodePipeline
# 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/codepipeline.html#codepipeline
apiVersion: aws.konfig.io/v1alpha1
kind: CodePipeline
metadata:
  name: example-codepipeline
  namespace: default
spec:
  artifactStore:
    location: example
    type: S3
  pipelineName: example-codepipeline
  providerRef:
    name: example-codepipeline
    region: us-east-1
  roleARN: arn:aws:iam::123456789012:role/example-role
  stages:
  - actions:
    - actionTypeID:
        category: example
        owner: example
        provider: example
        version: '1.0'
      inputArtifacts:
      - example
      name: example-codepipeline
      outputArtifacts:
      - example
      runOrder: 1
    name: example-codepipeline
  tags:
    environment: dev
    team: platform

Spec

Field	Type	Required	Description
`artifactStore`	object	yes	ArtifactStore defines the artifact store.
`artifactStore.location`	string	yes	Location is the S3 bucket name.
`artifactStore.type`	enum	yes	Type is the artifact store type (S3). Allowed: `S3`
`pipelineName`	string	yes	PipelineName is the name of the pipeline.
`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.
`roleARN`	string	yes	RoleARN is the IAM role ARN for CodePipeline.
`stages`	array<object>	yes	Stages is the ordered list of pipeline stages (minimum 2).
`stages[].actions`	array<object>	yes	Actions is the list of actions in this stage.
`stages[].actions[].actionTypeID`	object	yes	ActionTypeID identifies the action type.
`stages[].actions[].actionTypeID.category`	string	yes	Category is the action category (Source, Build, Deploy, etc.).
`stages[].actions[].actionTypeID.owner`	string	yes	Owner is the action owner (AWS, ThirdParty, or Custom).
`stages[].actions[].actionTypeID.provider`	string	yes	Provider is the action provider (e.g.
`stages[].actions[].actionTypeID.version`	string	yes	Version is the action version (typically "1").
`stages[].actions[].configuration`	map<string>	—	Configuration is the action configuration key/value pairs.
`stages[].actions[].inputArtifacts`	array<string>	—	InputArtifacts is the list of input artifact names.
`stages[].actions[].name`	string	yes	Name is the action name.
`stages[].actions[].outputArtifacts`	array<string>	—	OutputArtifacts is the list of output artifact names.
`stages[].actions[].runOrder`	integer	—	RunOrder is the action run order within the stage.
`stages[].name`	string	yes	Name is the stage name.
`tags`	map<string>	—	Tags are metadata tags for the pipeline.

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.
`pipelineARN`	string	—	PipelineARN is the ARN of the pipeline.

CodePipelineCustomActionType # CLOUD CONTROL · AWS::CodePipeline::CustomActionType

CodePipelineCustomActionType manages AWS::CodePipeline::CustomActionType through the AWS Cloud Control API.

kubectl get codepipelinecustomactiontypes · example on GitHub

Example

# CodePipelineCustomActionType — CodePipeline
# 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/codepipeline.html#codepipelinecustomactiontype
apiVersion: aws.konfig.io/v1alpha1
kind: CodePipelineCustomActionType
metadata:
  name: example-codepipelinecustomactiontype
  namespace: default
spec:
  category: example
  configurationProperties:
  - description: Managed by konfig-konector
    key: false
    name: example-codepipelinecustomactiontype
    queryable: false
    required: false
    secret: false
    type: example
  inputArtifactDetails:
    maximumCount: 2
    minimumCount: 2
  outputArtifactDetails:
    maximumCount: 2
    minimumCount: 2
  provider: example
  providerRef:
    name: example-codepipelinecustomactiontype
    region: us-east-1
  settings:
    entityUrlTemplate: example
    executionUrlTemplate: example
    revisionUrlTemplate: example
    thirdPartyConfigurationUrl: example
  tags:
  - key: example
    value: example
  version: '1.0'

Spec

Field	Type	Required	Description
`category`	string	yes	The category of the custom action, such as a build action or a test action.
`configurationProperties`	array<object>	—	The configuration properties for the custom action.
`configurationProperties[].description`	string	—	The description of the action configuration property that is displayed to users.
`configurationProperties[].key`	boolean	yes	Whether the configuration property is a key.
`configurationProperties[].name`	string	yes	The name of the action configuration property.
`configurationProperties[].queryable`	boolean	—	Indicates that the property is used with PollForJobs.
`configurationProperties[].required`	boolean	yes	Whether the configuration property is a required value.
`configurationProperties[].secret`	boolean	yes	Whether the configuration property is secret.
`configurationProperties[].type`	string	—	The type of the configuration property.
`inputArtifactDetails`	object	yes	The details of the input artifact for the action, such as its commit ID.
`inputArtifactDetails.maximumCount`	integer	yes	The maximum number of artifacts allowed for the action type.
`inputArtifactDetails.minimumCount`	integer	yes	The minimum number of artifacts allowed for the action type.
`outputArtifactDetails`	object	yes	The details of the output artifact of the action, such as its commit ID.
`outputArtifactDetails.maximumCount`	integer	yes	The maximum number of artifacts allowed for the action type.
`outputArtifactDetails.minimumCount`	integer	yes	The minimum number of artifacts allowed for the action type.
`provider`	string	yes	The provider of the service used in the custom action, such as AWS CodeDeploy.
`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.
`settings`	object	—	URLs that provide users information about this custom action.
`settings.entityUrlTemplate`	string	—	The URL returned to the AWS CodePipeline console that provides a deep link to the resources of the external system, such as the configuration page for an AWS CodeDeploy deployment group.
`settings.executionUrlTemplate`	string	—	The URL returned to the AWS CodePipeline console that contains a link to the top-level landing page for the external system, such as the console page for AWS CodeDeploy.
`settings.revisionUrlTemplate`	string	—	The URL returned to the AWS CodePipeline console that contains a link to the page where customers can update or change the configuration of the external action.
`settings.thirdPartyConfigurationUrl`	string	—	The URL of a sign-up page where users can sign up for an external service and perform initial configuration of the action provided by that service.
`tags`	array<object>	—	Any tags assigned to the custom action.
`tags[].key`	string	yes
`tags[].value`	string	yes
`version`	string	yes	The version identifier of the custom action.

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

CodePipelineWebhook # CLOUD CONTROL · AWS::CodePipeline::Webhook

CodePipelineWebhook manages AWS::CodePipeline::Webhook through the AWS Cloud Control API.

kubectl get codepipelinewebhooks · example on GitHub

Example

# CodePipelineWebhook — CodePipeline
# 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/codepipeline.html#codepipelinewebhook
apiVersion: aws.konfig.io/v1alpha1
kind: CodePipelineWebhook
metadata:
  name: example-codepipelinewebhook
  namespace: default
spec:
  authentication: GITHUB_HMAC
  authenticationConfiguration:
    allowedIPRange: example
    secretToken: example
  filters:
  - jsonPath: example
    matchEquals: example
  name: example-codepipelinewebhook
  providerRef:
    name: example-codepipelinewebhook
    region: us-east-1
  registerWithThirdParty: false
  tags:
  - key: example
    value: example
  targetAction: example
  targetPipeline: example
  targetPipelineVersion: 1

Spec

Field	Type	Required	Description
`authentication`	enum	yes	Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED. Allowed: `GITHUB_HMAC, IP, UNAUTHENTICATED`
`authenticationConfiguration`	object	yes	Properties that configure the authentication applied to incoming webhook trigger requests
`authenticationConfiguration.allowedIPRange`	string	—	The property used to configure acceptance of webhooks in an IP address range.
`authenticationConfiguration.secretToken`	string	—	The property used to configure GitHub authentication.
`filters`	array<object>	yes	A list of rules applied to the body/payload sent in the POST request to a webhook URL
`filters[].jsonPath`	string	yes	A JsonPath expression that is applied to the body/payload of the webhook.
`filters[].matchEquals`	string	—	The value selected by the JsonPath expression must match what is supplied in the MatchEquals field.
`name`	string	—	The name of the webhook Create-only in AWS: changing it requires replacing the 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.
`registerWithThirdParty`	boolean	—	Configures a connection between the webhook that was created and the external tool with events to be detected.
`tags`	array<object>	—	An array of key-value pairs to apply to this resource.
`tags[].key`	string	yes
`tags[].value`	string	yes
`targetAction`	string	yes	The name of the action in a pipeline you want to connect to the webhook.
`targetPipeline`	string	yes	The name of the pipeline you want to connect to the webhook.
`targetPipelineVersion`	integer	—	The version number of the pipeline to be connected to the trigger request.

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	—	logical id of the webhook 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.
`url`	string	—	The webhook URL generated by AWS CodePipeline Read-only: reported by AWS after creation.