CodeStar Notifications

1 resource kind. Generated from the operator's CRD schemas.

API Group: aws.konfig.io/v1alpha1

CodeStarNotificationsNotificationRule # CLOUD CONTROL · AWS::CodeStarNotifications::NotificationRule

CodeStarNotificationsNotificationRule manages AWS::CodeStarNotifications::NotificationRule through the AWS Cloud Control API.

kubectl get codestarnotificationsnotificationrules · example on GitHub

Example

# CodeStarNotificationsNotificationRule — CodeStar Notifications
# 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/codestarnotifications.html#codestarnotificationsnotificationrule
apiVersion: aws.konfig.io/v1alpha1
kind: CodeStarNotificationsNotificationRule
metadata:
  name: example-codestarnotificationsnotificationrule
  namespace: default
spec:
  createdBy: example
  detailType: BASIC
  eventTypeIds:
  - example
  name: example-codestarnotificationsnotificationrule
  providerRef:
    name: example-codestarnotificationsnotificationrule
    region: us-east-1
  resource: example
  status: ENABLED
  tags:
    environment: dev
    team: platform
  targetAddress: example
  targets:
  - targetAddress: example
    targetType: example

Spec

FieldTypeRequiredDescription
createdBystring—
detailTypeenumyesAllowed: BASIC, FULL
eventTypeIdstring—
eventTypeIdsarray<string>yes
namestringyes
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.
resourcestringyesCreate-only in AWS: changing it requires replacing the resource.
statusenum—Allowed: ENABLED, DISABLED
tagsmap<string>—
targetAddressstring—
targetsarray<object>yes
targets[].targetAddressstringyes
targets[].targetTypestringyes

Status

FieldTypeRequiredDescription
arnstring—Read-only: reported by AWS after creation.
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.