EventBridge

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

API Group: aws.konfig.io/v1alpha1

ECSScheduledTask # GA

ECSScheduledTask is the Schema for managing ECS scheduled tasks via EventBridge rules.

kubectl get ecsscheduledtasks · example on GitHub

Example

# ECSScheduledTask — EventBridge
# 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/eventbridge.html#ecsscheduledtask
apiVersion: aws.konfig.io/v1alpha1
kind: ECSScheduledTask
metadata:
  name: example-ecsscheduledtask
  namespace: default
spec:
  description: Managed by konfig-konector
  eventBusName: example-ecsscheduledtask
  providerRef:
    name: example-ecsscheduledtask
    region: us-east-1
  roleArn: arn:aws:iam::123456789012:role/example-role
  ruleName: example-ecsscheduledtask
  scheduleExpression: example
  tags:
    environment: dev
    team: platform
  target:
    clusterArn: arn:aws:iam::123456789012:role/example-role
    launchType: FARGATE
    networkConfiguration:
      assignPublicIp: ENABLED
      securityGroups:
      - example
      subnets:
      - example
    platformVersion: '1.0'
    taskCount: 2
    taskDefinitionArn: arn:aws:iam::123456789012:role/example-role

Spec

FieldTypeRequiredDescription
descriptionstring—Description is an optional description for the rule.
eventBusNamestring—EventBusName is the event bus name or ARN (defaults to default bus).
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.
roleArnstringyesRoleARN is the IAM role ARN used to invoke the ECS task.
ruleNamestringyesRuleName is the name for the EventBridge rule.
scheduleExpressionstringyesScheduleExpression is the schedule expression (e.g., "rate(5 minutes)" or "cron(0 12 * * ? *)").
tagsmap<string>—Tags are metadata tags for the EventBridge rule.
targetobjectyesTarget is the ECS task target configuration.
target.clusterArnstringyesClusterARN is the ARN of the ECS cluster.
target.launchTypeenum—LaunchType is the launch type to use (FARGATE or EC2). Allowed: FARGATE, EC2, EXTERNAL
target.networkConfigurationobject—NetworkConfiguration is the network configuration for the task.
target.networkConfiguration.assignPublicIpenum—AssignPublicIP determines whether to assign a public IP. Allowed: ENABLED, DISABLED
target.networkConfiguration.securityGroupsarray<string>—SecurityGroups are the security group IDs for the task.
target.networkConfiguration.subnetsarray<string>yesSubnets are the subnet IDs for the task.
target.platformVersionstring—PlatformVersion is the Fargate platform version (e.g., "LATEST").
target.taskCountinteger—TaskCount is the number of tasks to run (defaults to 1).
target.taskDefinitionArnstringyesTaskDefinitionARN is the ARN of the ECS task definition.

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.
ruleArnstring—RuleARN is the ARN of the EventBridge rule.
targetIdstring—TargetID is the ID of the EventBridge rule target.

EventBridgeApiDestination # CLOUD CONTROL · AWS::Events::ApiDestination

EventBridgeApiDestination manages AWS::Events::ApiDestination through the AWS Cloud Control API.

kubectl get eventbridgeapidestinations · example on GitHub

Example

# EventBridgeApiDestination — EventBridge
# 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/eventbridge.html#eventbridgeapidestination
apiVersion: aws.konfig.io/v1alpha1
kind: EventBridgeApiDestination
metadata:
  name: example-eventbridgeapidestination
  namespace: default
spec:
  connectionArn: arn:aws:iam::123456789012:role/example-role
  description: Managed by konfig-konector
  httpMethod: GET
  invocationEndpoint: example
  invocationRateLimitPerSecond: 1
  name: example-eventbridgeapidestination
  providerRef:
    name: example-eventbridgeapidestination
    region: us-east-1

Spec

FieldTypeRequiredDescription
connectionArnstringyesThe arn of the connection.
descriptionstring—
httpMethodenumyesAllowed: GET, HEAD, POST, OPTIONS, PUT, DELETE, PATCH
invocationEndpointstringyesUrl endpoint to invoke.
invocationRateLimitPerSecondinteger—
namestring—Name of the apiDestination.
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.

Status

FieldTypeRequiredDescription
arnstring—The arn of the api destination.
arnForPolicystring—The arn of the api destination to be used in IAM policies.
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.

EventBridgeArchive # CLOUD CONTROL · AWS::Events::Archive

EventBridgeArchive manages AWS::Events::Archive through the AWS Cloud Control API.

kubectl get eventbridgearchives · example on GitHub

Example

# EventBridgeArchive — EventBridge
# 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/eventbridge.html#eventbridgearchive
apiVersion: aws.konfig.io/v1alpha1
kind: EventBridgeArchive
metadata:
  name: example-eventbridgearchive
  namespace: default
spec:
  archiveName: example-eventbridgearchive
  description: Managed by konfig-konector
  kmsKeyIdentifier: example
  providerRef:
    name: example-eventbridgearchive
    region: us-east-1
  retentionDays: 7
  sourceArn: arn:aws:iam::123456789012:role/example-role

Spec

FieldTypeRequiredDescription
archiveNamestring—Create-only in AWS: changing it requires replacing the resource.
descriptionstring—
eventPatternobject—
kmsKeyIdentifierstring—
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.
retentionDaysinteger—
sourceArnstringyesCreate-only in AWS: changing it requires replacing the resource.

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.

EventBridgeConnection # CLOUD CONTROL · AWS::Events::Connection

EventBridgeConnection manages AWS::Events::Connection through the AWS Cloud Control API.

kubectl get eventbridgeconnections · example on GitHub

Example

# EventBridgeConnection — EventBridge
# 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/eventbridge.html#eventbridgeconnection
apiVersion: aws.konfig.io/v1alpha1
kind: EventBridgeConnection
metadata:
  name: example-eventbridgeconnection
  namespace: default
spec:
  authParameters:
    apiKeyAuthParameters:
      apiKeyName: example-eventbridgeconnection
      apiKeyValue: example
    basicAuthParameters:
      password: example
      username: example-eventbridgeconnection
    connectivityParameters:
      resourceParameters:
        resourceAssociationArn: arn:aws:iam::123456789012:role/example-role
        resourceConfigurationArn: arn:aws:iam::123456789012:role/example-role
    invocationHttpParameters:
      bodyParameters:
      - isValueSecret: false
        key: example
        value: example
      headerParameters:
      - isValueSecret: false
        key: example
        value: example
      queryStringParameters:
      - isValueSecret: false
        key: example
        value: example
    oAuthParameters:
      authorizationEndpoint: example
      clientParameters:
        clientID: example-id
        clientSecret: example
      httpMethod: GET
      oAuthHttpParameters:
        bodyParameters:
        - isValueSecret: false
          key: example
          value: example
        headerParameters:
        - isValueSecret: false
          key: example
          value: example
        queryStringParameters:
        - isValueSecret: false
          key: example
          value: example
  authorizationType: API_KEY
  description: Managed by konfig-konector
  invocationConnectivityParameters:
    resourceParameters:
      resourceAssociationArn: arn:aws:iam::123456789012:role/example-role
      resourceConfigurationArn: arn:aws:iam::123456789012:role/example-role
  kmsKeyIdentifier: example
  name: example-eventbridgeconnection
  providerRef:
    name: example-eventbridgeconnection
    region: us-east-1

Spec

FieldTypeRequiredDescription
authParametersobject—EventBridgeConnectionAuthParameters is a nested property type of AWS::Events::Connection.
authParameters.apiKeyAuthParametersobject—EventBridgeConnectionApiKeyAuthParameters is a nested property type of AWS::Events::Connection.
authParameters.apiKeyAuthParameters.apiKeyNamestringyes
authParameters.apiKeyAuthParameters.apiKeyValuestringyes
authParameters.basicAuthParametersobject—EventBridgeConnectionBasicAuthParameters is a nested property type of AWS::Events::Connection.
authParameters.basicAuthParameters.passwordstringyes
authParameters.basicAuthParameters.usernamestringyes
authParameters.connectivityParametersobject—EventBridgeConnectionConnectivityParameters is a nested property type of AWS::Events::Connection.
authParameters.connectivityParameters.resourceParametersobjectyesEventBridgeConnectionResourceParameters is a nested property type of AWS::Events::Connection.
authParameters.connectivityParameters.resourceParameters.resourceAssociationArnstring—
authParameters.connectivityParameters.resourceParameters.resourceConfigurationArnstringyes
authParameters.invocationHttpParametersobject—EventBridgeConnectionConnectionHttpParameters is a nested property type of AWS::Events::Connection.
authParameters.invocationHttpParameters.bodyParametersarray<object>—
authParameters.invocationHttpParameters.bodyParameters[].isValueSecretboolean—
authParameters.invocationHttpParameters.bodyParameters[].keystringyes
authParameters.invocationHttpParameters.bodyParameters[].valuestringyes
authParameters.invocationHttpParameters.headerParametersarray<object>—
authParameters.invocationHttpParameters.headerParameters[].isValueSecretboolean—
authParameters.invocationHttpParameters.headerParameters[].keystringyes
authParameters.invocationHttpParameters.headerParameters[].valuestringyes
authParameters.invocationHttpParameters.queryStringParametersarray<object>—
authParameters.invocationHttpParameters.queryStringParameters[].isValueSecretboolean—
authParameters.invocationHttpParameters.queryStringParameters[].keystringyes
authParameters.invocationHttpParameters.queryStringParameters[].valuestringyes
authParameters.oAuthParametersobject—EventBridgeConnectionOAuthParameters is a nested property type of AWS::Events::Connection.
authParameters.oAuthParameters.authorizationEndpointstringyes
authParameters.oAuthParameters.clientParametersobjectyesEventBridgeConnectionClientParameters is a nested property type of AWS::Events::Connection.
authParameters.oAuthParameters.clientParameters.clientIDstringyes
authParameters.oAuthParameters.clientParameters.clientSecretstringyes
authParameters.oAuthParameters.httpMethodenumyesAllowed: GET, POST, PUT
authParameters.oAuthParameters.oAuthHttpParametersobject—EventBridgeConnectionConnectionHttpParameters is a nested property type of AWS::Events::Connection.
authParameters.oAuthParameters.oAuthHttpParameters.bodyParametersarray<object>—
authParameters.oAuthParameters.oAuthHttpParameters.bodyParameters[].isValueSecretboolean—
authParameters.oAuthParameters.oAuthHttpParameters.bodyParameters[].keystringyes
authParameters.oAuthParameters.oAuthHttpParameters.bodyParameters[].valuestringyes
authParameters.oAuthParameters.oAuthHttpParameters.headerParametersarray<object>—
authParameters.oAuthParameters.oAuthHttpParameters.headerParameters[].isValueSecretboolean—
authParameters.oAuthParameters.oAuthHttpParameters.headerParameters[].keystringyes
authParameters.oAuthParameters.oAuthHttpParameters.headerParameters[].valuestringyes
authParameters.oAuthParameters.oAuthHttpParameters.queryStringParametersarray<object>—
authParameters.oAuthParameters.oAuthHttpParameters.queryStringParameters[].isValueSecretboolean—
authParameters.oAuthParameters.oAuthHttpParameters.queryStringParameters[].keystringyes
authParameters.oAuthParameters.oAuthHttpParameters.queryStringParameters[].valuestringyes
authorizationTypeenum—Allowed: API_KEY, BASIC, OAUTH_CLIENT_CREDENTIALS
descriptionstring—Description of the connection.
invocationConnectivityParametersobject—The private resource the HTTP request will be sent to.
invocationConnectivityParameters.resourceParametersobjectyesEventBridgeConnectionResourceParameters is a nested property type of AWS::Events::Connection.
invocationConnectivityParameters.resourceParameters.resourceAssociationArnstring—
invocationConnectivityParameters.resourceParameters.resourceConfigurationArnstringyes
kmsKeyIdentifierstring—
namestring—Name of the connection.
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.

Status

FieldTypeRequiredDescription
arnstring—The arn of the connection resource.
arnForPolicystring—The arn of the connection resource to be used in IAM policies.
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.
secretArnstring—The arn of the secrets manager secret created in the customer account.

EventBridgeEndpoint # CLOUD CONTROL · AWS::Events::Endpoint

EventBridgeEndpoint manages AWS::Events::Endpoint through the AWS Cloud Control API.

kubectl get eventbridgeendpoints · example on GitHub

Example

# EventBridgeEndpoint — EventBridge
# 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/eventbridge.html#eventbridgeendpoint
apiVersion: aws.konfig.io/v1alpha1
kind: EventBridgeEndpoint
metadata:
  name: example-eventbridgeendpoint
  namespace: default
spec:
  description: Managed by konfig-konector
  eventBuses:
  - eventBusArn: arn:aws:iam::123456789012:role/example-role
  name: example-eventbridgeendpoint
  providerRef:
    name: example-eventbridgeendpoint
    region: us-east-1
  replicationConfig:
    state: ENABLED
  roleArn: arn:aws:iam::123456789012:role/example-role
  routingConfig:
    failoverConfig:
      primary:
        healthCheck: example
      secondary:
        route: example-x

Spec

FieldTypeRequiredDescription
descriptionstring—
eventBusesarray<object>yes
eventBuses[].eventBusArnstringyes
namestring—Create-only in AWS: changing it requires replacing the resource.
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.
replicationConfigobject—EventBridgeEndpointReplicationConfig is a nested property type of AWS::Events::Endpoint.
replicationConfig.stateenumyesAllowed: ENABLED, DISABLED
roleArnstring—
routingConfigobjectyesEventBridgeEndpointRoutingConfig is a nested property type of AWS::Events::Endpoint.
routingConfig.failoverConfigobjectyesEventBridgeEndpointFailoverConfig is a nested property type of AWS::Events::Endpoint.
routingConfig.failoverConfig.primaryobjectyesEventBridgeEndpointPrimary is a nested property type of AWS::Events::Endpoint.
routingConfig.failoverConfig.primary.healthCheckstringyes
routingConfig.failoverConfig.secondaryobjectyesEventBridgeEndpointSecondary is a nested property type of AWS::Events::Endpoint.
routingConfig.failoverConfig.secondary.routestringyes

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.
endpointIdstring—Read-only: reported by AWS after creation.
endpointUrlstring—Read-only: reported by AWS after creation.
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.
stateenum—Read-only: reported by AWS after creation. Allowed: ACTIVE, CREATING, UPDATING, DELETING, CREATE_FAILED, UPDATE_FAILED
stateReasonstring—Read-only: reported by AWS after creation.

EventBridgeEventBusPolicy # CLOUD CONTROL · AWS::Events::EventBusPolicy

EventBridgeEventBusPolicy manages AWS::Events::EventBusPolicy through the AWS Cloud Control API.

kubectl get eventbridgeeventbuspolicies · example on GitHub

Example

# EventBridgeEventBusPolicy — EventBridge
# 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/eventbridge.html#eventbridgeeventbuspolicy
apiVersion: aws.konfig.io/v1alpha1
kind: EventBridgeEventBusPolicy
metadata:
  name: example-eventbridgeeventbuspolicy
  namespace: default
spec:
  action: example
  condition:
    key: example
    type: example
    value: example
  eventBusName: example-eventbridgeeventbuspolicy
  principal: example
  providerRef:
    name: example-eventbridgeeventbuspolicy
    region: us-east-1
  statementId: example-id

Spec

FieldTypeRequiredDescription
actionstring—The action that you are enabling the other account to perform.
conditionobject—EventBridgeEventBusPolicyCondition is a nested property type of AWS::Events::EventBusPolicy.
condition.keystring—Specifies the value for the key.
condition.typestring—Specifies the type of condition.
condition.valuestring—Specifies the key for the condition.
eventBusNamestring—The name of the event bus associated with the rule.
principalstring—The 12-digit AWS account ID that you are permitting to put events to your default event bus.
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.
statementobject—A JSON string that describes the permission policy statement.
statementIdstringyesAn identifier string for the external account that you are granting permissions to Create-only in AWS: changing it requires replacing the resource.

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.

EventBus # GA

EventBus is the Schema for managing EventBridge Event Buses.

kubectl get eventbuses · example on GitHub

Example

# EventBus — EventBridge
# 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/eventbridge.html#eventbus
apiVersion: aws.konfig.io/v1alpha1
kind: EventBus
metadata:
  name: example-eventbus
  namespace: default
spec:
  eventBusName: example-eventbus
  providerRef:
    name: example-eventbus
    region: us-east-1
  tags:
    environment: dev
    team: platform

Spec

FieldTypeRequiredDescription
eventBusNamestringyesEventBusName is the name of the event bus.
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
arnstring—ARN is the ARN of the event bus.
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.

EventRule # GA

EventRule is the Schema for managing EventBridge Rules.

kubectl get eventrules · example on GitHub

Example

# EventRule — EventBridge
# 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/eventbridge.html#eventrule
apiVersion: aws.konfig.io/v1alpha1
kind: EventRule
metadata:
  name: example-eventrule
  namespace: default
spec:
  description: Managed by konfig-konector
  eventBusRef:
    eventBusName: example-eventrule
    name: example-eventrule
  eventPattern: example
  providerRef:
    name: example-eventrule
    region: us-east-1
  roleArn: arn:aws:iam::123456789012:role/example-role
  ruleName: example-eventrule
  scheduleExpression: example
  state: ENABLED
  tags:
    environment: dev
    team: platform

Spec

FieldTypeRequiredDescription
descriptionstring—Description is a human-readable description.
eventBusRefobject—EventBusRef references the event bus.
eventBusRef.eventBusNamestring—EventBusName is a direct AWS event bus name or ARN.
eventBusRef.namestring—Name of an EventBus CR in the same namespace.
eventPatternstring—EventPattern is the JSON event pattern.
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.
roleArnstring—RoleARN is the IAM role ARN for the rule to invoke targets.
ruleNamestringyesRuleName is the name of the rule.
scheduleExpressionstring—ScheduleExpression is a cron or rate schedule expression.
stateenum—State enables or disables the rule. Allowed: ENABLED, DISABLED
tagsmap<string>—Tags are AWS resource tags to apply.

Status

FieldTypeRequiredDescription
arnstring—ARN is the ARN of the rule.
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.

EventTarget # GA

EventTarget is the Schema for managing EventBridge Targets.

kubectl get eventtargets · example on GitHub

Example

# EventTarget — EventBridge
# 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/eventbridge.html#eventtarget
apiVersion: aws.konfig.io/v1alpha1
kind: EventTarget
metadata:
  name: example-eventtarget
  namespace: default
spec:
  eventBusRef:
    eventBusName: example-eventtarget
    name: example-eventtarget
  eventRuleRef:
    name: example-eventtarget
    ruleName: example-eventtarget
  providerRef:
    name: example-eventtarget
    region: us-east-1
  targets:
  - arn: arn:aws:iam::123456789012:role/example-role
    id: example-id
    input: example
    inputPath: example
    roleArn: arn:aws:iam::123456789012:role/example-role

Spec

FieldTypeRequiredDescription
eventBusRefobject—EventBusRef identifies the event bus of the rule.
eventBusRef.eventBusNamestring—EventBusName is a direct AWS event bus name or ARN.
eventBusRef.namestring—Name of an EventBus CR in the same namespace.
eventRuleRefobjectyesEventRuleRef references the event rule.
eventRuleRef.namestring—Name of an EventRule CR in the same namespace.
eventRuleRef.ruleNamestring—RuleName is a direct AWS EventBridge rule name.
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.
targetsarray<object>yesTargets are the targets to add to the rule.
targets[].arnstringyesARN is the ARN of the target resource.
targets[].idstringyesID is the unique identifier for the target.
targets[].inputstring—Input is a literal JSON string to pass to the target.
targets[].inputPathstring—InputPath is a JSONPath expression applied to the event.
targets[].roleArnstring—RoleARN is the IAM role ARN to use for invoking this target.

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.