IAM Access Analyzer

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

API Group: aws.konfig.io/v1alpha1

AccessAnalyzerAnalyzer # CLOUD CONTROL · AWS::AccessAnalyzer::Analyzer

AccessAnalyzerAnalyzer manages AWS::AccessAnalyzer::Analyzer through the AWS Cloud Control API.

kubectl get accessanalyzeranalyzers · example on GitHub

Example

# AccessAnalyzerAnalyzer — IAM Access Analyzer
# 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/accessanalyzer.html#accessanalyzeranalyzer
apiVersion: aws.konfig.io/v1alpha1
kind: AccessAnalyzerAnalyzer
metadata:
  name: example-accessanalyzeranalyzer
  namespace: default
spec:
  analyzerConfiguration:
    internalAccessConfiguration:
      internalAccessAnalysisRule:
        inclusions:
        - accountIds:
          - example
          resourceArns:
          - example
          resourceTypes:
          - example
    unusedAccessConfiguration:
      analysisRule:
        exclusions:
        - accountIds:
          - example
          resourceTags:
          - - key: example
              value: example
      unusedAccessAge: 1
  analyzerName: example-accessanalyzeranalyzer
  archiveRules:
  - filter:
    - contains:
      - example
      eq:
      - example
      exists: false
      neq:
      - example
      property: example
    ruleName: example-accessanalyzeranalyzer
  providerRef:
    name: example-accessanalyzeranalyzer
    region: us-east-1
  tags:
  - key: example
    value: example
  type: example

Spec

FieldTypeRequiredDescription
analyzerConfigurationobject—The configuration for the analyzer
analyzerConfiguration.internalAccessConfigurationobject—AccessAnalyzerAnalyzerInternalAccessConfiguration is a nested property type of AWS::AccessAnalyzer::Analyzer.
analyzerConfiguration.internalAccessConfiguration.internalAccessAnalysisRuleobject—Contains information about analysis rules for the internal access analyzer.
analyzerConfiguration.internalAccessConfiguration.internalAccessAnalysisRule.inclusionsarray<object>—A list of rules for the internal access analyzer containing criteria to include in analysis.
analyzerConfiguration.internalAccessConfiguration.internalAccessAnalysisRule.inclusions[].accountIdsarray<string>—A list of AWS account IDs to apply to the internal access analysis rule criteria.
analyzerConfiguration.internalAccessConfiguration.internalAccessAnalysisRule.inclusions[].resourceArnsarray<string>—A list of resource ARNs to apply to the internal access analysis rule criteria.
analyzerConfiguration.internalAccessConfiguration.internalAccessAnalysisRule.inclusions[].resourceTypesarray<string>—A list of resource types to apply to the internal access analysis rule criteria.
analyzerConfiguration.unusedAccessConfigurationobject—AccessAnalyzerAnalyzerUnusedAccessConfiguration is a nested property type of AWS::AccessAnalyzer::Analyzer.
analyzerConfiguration.unusedAccessConfiguration.analysisRuleobject—Contains information about rules for the analyzer.
analyzerConfiguration.unusedAccessConfiguration.analysisRule.exclusionsarray<object>—A list of rules for the analyzer containing criteria to exclude from analysis.
analyzerConfiguration.unusedAccessConfiguration.analysisRule.exclusions[].accountIdsarray<string>—A list of AWS account IDs to apply to the analysis rule criteria.
analyzerConfiguration.unusedAccessConfiguration.analysisRule.exclusions[].resourceTagsarray<array>—An array of key-value pairs to match for your resources.
analyzerConfiguration.unusedAccessConfiguration.unusedAccessAgeinteger—The specified access age in days for which to generate findings for unused access.
analyzerNamestring—Analyzer name Create-only in AWS: changing it requires replacing the resource.
archiveRulesarray<object>—
archiveRules[].filterarray<object>yes
archiveRules[].filter[].containsarray<string>—
archiveRules[].filter[].eqarray<string>—
archiveRules[].filter[].existsboolean—
archiveRules[].filter[].neqarray<string>—
archiveRules[].filter[].propertystringyes
archiveRules[].ruleNamestringyesThe archive 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.
tagsarray<object>—An array of key-value pairs to apply to this resource.
tags[].keystringyes
tags[].valuestringyes
typestringyesThe type of the analyzer, must be one of ACCOUNT, ORGANIZATION, ACCOUNT_INTERNAL_ACCESS, ORGANIZATION_INTERNAL_ACCESS, ACCOUNT_UNUSED_ACCESS and ORGANIZATION_UNUSED_ACCESS Create-only in AWS: changing it requires replacing the resource.

Status

FieldTypeRequiredDescription
arnstring—Amazon Resource Name (ARN) of the analyzer 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.

AccessAnalyzerArchiveRule # CLOUD CONTROL · AWS::AccessAnalyzer::ArchiveRule

AccessAnalyzerArchiveRule manages AWS::AccessAnalyzer::ArchiveRule through the AWS Cloud Control API.

kubectl get accessanalyzerarchiverules · example on GitHub

Example

# AccessAnalyzerArchiveRule — IAM Access Analyzer
# 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/accessanalyzer.html#accessanalyzerarchiverule
apiVersion: aws.konfig.io/v1alpha1
kind: AccessAnalyzerArchiveRule
metadata:
  name: example-accessanalyzerarchiverule
  namespace: default
spec:
  analyzerName: example-accessanalyzerarchiverule
  filter: {}
  providerRef:
    name: example-accessanalyzerarchiverule
    region: us-east-1
  ruleName: example-accessanalyzerarchiverule

Spec

FieldTypeRequiredDescription
analyzerNamestringyesThe name of the analyzer for the archive rule.
filtermap<string>yesThe criteria for the archive rule.
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.
ruleNamestringyesThe name of the archive rule.

Status

FieldTypeRequiredDescription
arnstring—The ARN of the archive rule.
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.
createdAtstring—The time at which the archive rule was created.
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.
updatedAtstring—The time at which the archive rule was last updated.