Detective

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

API Group: aws.konfig.io/v1alpha1

DetectiveGraph # CLOUD CONTROL · AWS::Detective::Graph

DetectiveGraph manages AWS::Detective::Graph through the AWS Cloud Control API.

kubectl get detectivegraphs · example on GitHub

Example

# DetectiveGraph — Detective
# 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/detective.html#detectivegraph
apiVersion: aws.konfig.io/v1alpha1
kind: DetectiveGraph
metadata:
  name: example-detectivegraph
  namespace: default
spec:
  autoEnableMembers: true
  providerRef:
    name: example-detectivegraph
    region: us-east-1
  tags:
  - key: example
    value: example

Spec

FieldTypeRequiredDescription
autoEnableMembersboolean—Indicates whether to automatically enable new organization accounts as member accounts in the organization behavior graph.
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.
tagsarray<object>—
tags[].keystringyes
tags[].valuestringyes

Status

FieldTypeRequiredDescription
arnstring—The Detective graph ARN 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.

DetectiveMemberInvitation # CLOUD CONTROL · AWS::Detective::MemberInvitation

DetectiveMemberInvitation manages AWS::Detective::MemberInvitation through the AWS Cloud Control API.

kubectl get detectivememberinvitations · example on GitHub

Example

# DetectiveMemberInvitation — Detective
# 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/detective.html#detectivememberinvitation
apiVersion: aws.konfig.io/v1alpha1
kind: DetectiveMemberInvitation
metadata:
  name: example-detectivememberinvitation
  namespace: default
spec:
  disableEmailNotification: false
  graphArn: arn:aws:iam::123456789012:role/example-role
  memberEmailAddress: ops@example.com
  memberId: example-id
  message: example
  providerRef:
    name: example-detectivememberinvitation
    region: us-east-1

Spec

FieldTypeRequiredDescription
disableEmailNotificationboolean—When set to true, invitation emails are not sent to the member accounts.
graphArnstringyesThe ARN of the graph to which the member account will be invited Create-only in AWS: changing it requires replacing the resource.
memberEmailAddressstringyesThe root email address for the account to be invited, for validation.
memberIdstringyesThe AWS account ID to be invited to join the graph as a member Create-only in AWS: changing it requires replacing the resource.
messagestring—A message to be included in the email invitation sent to the invited account.
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
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.

DetectiveOrganizationAdmin # CLOUD CONTROL · AWS::Detective::OrganizationAdmin ⚠ DESTRUCTIVE SCOPE

Caution, destructive scope: organization-wide delegated administrator. Provided for completeness; do not use from application namespaces. Restrict with AWSProvider.allowedNamespaces and RBAC. DetectiveOrganizationAdmin manages AWS::Detective::OrganizationAdmin through the AWS Cloud Control API.

kubectl get detectiveorganizationadmins · example on GitHub

Example

# DetectiveOrganizationAdmin — Detective
# 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/detective.html#detectiveorganizationadmin
apiVersion: aws.konfig.io/v1alpha1
kind: DetectiveOrganizationAdmin
metadata:
  name: example-detectiveorganizationadmin
  namespace: default
spec:
  accountId: '123456789012'
  providerRef:
    name: example-detectiveorganizationadmin
    region: us-east-1

Spec

FieldTypeRequiredDescription
accountIdstringyesThe account ID of the account that should be registered as your Organization's delegated administrator for Detective 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.

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.
graphArnstring—The Detective graph ARN 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.