Incident Manager

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

API Group: aws.konfig.io/v1alpha1

SSMIncidentsReplicationSet # CLOUD CONTROL · AWS::SSMIncidents::ReplicationSet

SSMIncidentsReplicationSet manages AWS::SSMIncidents::ReplicationSet through the AWS Cloud Control API.

kubectl get ssmincidentsreplicationsets · example on GitHub

Example

# SSMIncidentsReplicationSet — Incident Manager
# 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/ssmincidents.html#ssmincidentsreplicationset
apiVersion: aws.konfig.io/v1alpha1
kind: SSMIncidentsReplicationSet
metadata:
  name: example-ssmincidentsreplicationset
  namespace: default
spec:
  deletionProtected: true
  providerRef:
    name: example-ssmincidentsreplicationset
    region: us-east-1
  regions:
  - regionConfiguration:
      sseKmsKeyId: arn:aws:kms:us-east-1:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab
    regionName: example-ssmincidents
  tags:
  - key: example
    value: example

Spec

Field	Type	Required	Description
`deletionProtected`	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.
`regions`	array<object>	yes	The ReplicationSet configuration.
`regions[].regionConfiguration`	object	—	SSMIncidentsReplicationSetRegionConfiguration is a nested property type of AWS::SSMIncidents::ReplicationSet.
`regions[].regionConfiguration.sseKmsKeyId`	string	yes	The AWS Key Management Service key ID or Key Alias to use to encrypt your replication set.
`regions[].regionName`	string	—
`tags`	array<object>	—	The tags to apply to the replication set.
`tags[].key`	string	yes
`tags[].value`	string	yes

Status

Field	Type	Required	Description
`arn`	string	—	The ARN of the ReplicationSet.
`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.

SSMIncidentsResponsePlan # CLOUD CONTROL · AWS::SSMIncidents::ResponsePlan

SSMIncidentsResponsePlan manages AWS::SSMIncidents::ResponsePlan through the AWS Cloud Control API.

kubectl get ssmincidentsresponseplans · example on GitHub

Example

# SSMIncidentsResponsePlan — Incident Manager
# 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/ssmincidents.html#ssmincidentsresponseplan
apiVersion: aws.konfig.io/v1alpha1
kind: SSMIncidentsResponsePlan
metadata:
  name: example-ssmincidentsresponseplan
  namespace: default
spec:
  actions:
  - ssmAutomation:
      documentName: example-ssmincidentsresponseplan
      documentVersion: '1.0'
      dynamicParameters:
      - key: example
        value:
          variable: INCIDENT_RECORD_ARN
      parameters:
      - key: example
        values:
        - example
      roleArn: arn:aws:iam::123456789012:role/example-role
      targetAccount: IMPACTED_ACCOUNT
  chatChannel:
    chatbotSns:
    - example
  displayName: example-ssmincidentsresponseplan
  engagements:
  - example
  incidentTemplate:
    dedupeString: example
    impact: 1
    incidentTags:
    - key: example
      value: example
    notificationTargets:
    - snsTopicArn: arn:aws:iam::123456789012:role/example-role
    summary: example
    title: example
  integrations:
  - pagerDutyConfiguration:
      name: example-ssmincidentsresponseplan
      pagerDutyIncidentConfiguration:
        serviceId: example-id
      secretId: example-id
  name: example-ssmincidentsresponseplan
  providerRef:
    name: example-ssmincidentsresponseplan
    region: us-east-1
  tags:
  - key: example
    value: example

Spec

Field	Type	Required	Description
`actions`	array<object>	—	The list of actions.
`actions[].ssmAutomation`	object	—	SSMIncidentsResponsePlanSsmAutomation is a nested property type of AWS::SSMIncidents::ResponsePlan.
`actions[].ssmAutomation.documentName`	string	yes	The document name to use when starting the SSM automation document.
`actions[].ssmAutomation.documentVersion`	string	—	The version of the document to use when starting the SSM automation document.
`actions[].ssmAutomation.dynamicParameters`	array<object>	—	The parameters with dynamic values to set when starting the SSM automation document.
`actions[].ssmAutomation.dynamicParameters[].key`	string	yes
`actions[].ssmAutomation.dynamicParameters[].value`	object	yes	SSMIncidentsResponsePlanDynamicSsmParameterValue is a nested property type of AWS::SSMIncidents::ResponsePlan.
`actions[].ssmAutomation.dynamicParameters[].value.variable`	enum	—	Allowed: `INCIDENT_RECORD_ARN, INVOLVED_RESOURCES`
`actions[].ssmAutomation.parameters`	array<object>	—	The parameters to set when starting the SSM automation document.
`actions[].ssmAutomation.parameters[].key`	string	yes
`actions[].ssmAutomation.parameters[].values`	array<string>	yes
`actions[].ssmAutomation.roleArn`	string	yes	The role ARN to use when starting the SSM automation document.
`actions[].ssmAutomation.targetAccount`	enum	—	The account type to use when starting the SSM automation document. Allowed: `IMPACTED_ACCOUNT, RESPONSE_PLAN_OWNER_ACCOUNT`
`chatChannel`	object	—	SSMIncidentsResponsePlanChatChannel is a nested property type of AWS::SSMIncidents::ResponsePlan.
`chatChannel.chatbotSns`	array<string>	—
`displayName`	string	—	The display name of the response plan.
`engagements`	array<string>	—	The list of engagements to use.
`incidentTemplate`	object	yes	SSMIncidentsResponsePlanIncidentTemplate is a nested property type of AWS::SSMIncidents::ResponsePlan.
`incidentTemplate.dedupeString`	string	—	The deduplication string.
`incidentTemplate.impact`	integer	yes	The impact value.
`incidentTemplate.incidentTags`	array<object>	—	Tags that get applied to incidents created by the StartIncident API action.
`incidentTemplate.incidentTags[].key`	string	yes
`incidentTemplate.incidentTags[].value`	string	yes
`incidentTemplate.notificationTargets`	array<object>	—	The list of notification targets.
`incidentTemplate.notificationTargets[].snsTopicArn`	string	—
`incidentTemplate.summary`	string	—	The summary string.
`incidentTemplate.title`	string	yes	The title string.
`integrations`	array<object>	—	The list of integrations.
`integrations[].pagerDutyConfiguration`	object	—	SSMIncidentsResponsePlanPagerDutyConfiguration is a nested property type of AWS::SSMIncidents::ResponsePlan.
`integrations[].pagerDutyConfiguration.name`	string	yes	The name of the pagerDuty configuration.
`integrations[].pagerDutyConfiguration.pagerDutyIncidentConfiguration`	object	yes	SSMIncidentsResponsePlanPagerDutyIncidentConfiguration is a nested property type of AWS::SSMIncidents::ResponsePlan.
`integrations[].pagerDutyConfiguration.pagerDutyIncidentConfiguration.serviceId`	string	yes	The pagerDuty serviceId.
`integrations[].pagerDutyConfiguration.secretId`	string	yes	The AWS secrets manager secretId storing the pagerDuty token.
`name`	string	yes	The name of the response plan.
`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>	—	The tags to apply to the response plan.
`tags[].key`	string	yes
`tags[].value`	string	yes

Status

Field	Type	Required	Description
`arn`	string	—	The ARN of the response plan.
`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.