Package software.amazon.awscdk.services.accessanalyzer

Class CfnAnalyzer

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.accessanalyzer.CfnAnalyzer
All Implemented Interfaces:
IInspectable, IAnalyzerRef, IEnvironmentAware, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)", date="2025-12-05T10:47:11.142Z") @Stability(Stable) public class CfnAnalyzer extends CfnResource implements IInspectable, IAnalyzerRef, ITaggable
The AWS::AccessAnalyzer::Analyzer resource specifies a new analyzer.

The analyzer is an object that represents the IAM Access Analyzer feature. An analyzer is required for Access Analyzer to become operational.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.accessanalyzer.*;
 CfnAnalyzer cfnAnalyzer = CfnAnalyzer.Builder.create(this, "MyCfnAnalyzer")
         .type("type")
         // the properties below are optional
         .analyzerConfiguration(AnalyzerConfigurationProperty.builder()
                 .internalAccessConfiguration(InternalAccessConfigurationProperty.builder()
                         .internalAccessAnalysisRule(InternalAccessAnalysisRuleProperty.builder()
                                 .inclusions(List.of(InternalAccessAnalysisRuleCriteriaProperty.builder()
                                         .accountIds(List.of("accountIds"))
                                         .resourceArns(List.of("resourceArns"))
                                         .resourceTypes(List.of("resourceTypes"))
                                         .build()))
                                 .build())
                         .build())
                 .unusedAccessConfiguration(UnusedAccessConfigurationProperty.builder()
                         .analysisRule(AnalysisRuleProperty.builder()
                                 .exclusions(List.of(AnalysisRuleCriteriaProperty.builder()
                                         .accountIds(List.of("accountIds"))
                                         .resourceTags(List.of(List.of(CfnTag.builder()
                                                 .key("key")
                                                 .value("value")
                                                 .build())))
                                         .build()))
                                 .build())
                         .unusedAccessAge(123)
                         .build())
                 .build())
         .analyzerName("analyzerName")
         .archiveRules(List.of(ArchiveRuleProperty.builder()
                 .filter(List.of(FilterProperty.builder()
                         .property("property")
                         // the properties below are optional
                         .contains(List.of("contains"))
                         .eq(List.of("eq"))
                         .exists(false)
                         .neq(List.of("neq"))
                         .build()))
                 .ruleName("ruleName")
                 .build()))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnAnalyzer

      protected CfnAnalyzer(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnAnalyzer

      protected CfnAnalyzer(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnAnalyzer

      @Stability(Stable) public CfnAnalyzer(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnAnalyzerProps props)
      Create a new AWS::AccessAnalyzer::Analyzer.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • arnForAnalyzer

      @Stability(Stable) @NotNull public static String arnForAnalyzer(@NotNull IAnalyzerRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnAnalyzer

      @Stability(Stable) @NotNull public static Boolean isCfnAnalyzer(@NotNull Object x)
      Checks whether the given object is a CfnAnalyzer.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAnalyzerRef

      @Stability(Stable) @NotNull public AnalyzerReference getAnalyzerRef()
      A reference to a Analyzer resource.
      Specified by:
      getAnalyzerRef in interface IAnalyzerRef

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The ARN of the analyzer that was created.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getType

      @Stability(Stable) @NotNull public String getType()
      The type represents the zone of trust for the analyzer.

    • setType

      @Stability(Stable) public void setType(@NotNull String value)
      The type represents the zone of trust for the analyzer.

    • getAnalyzerConfiguration

      @Stability(Stable) @Nullable public Object getAnalyzerConfiguration()
      Contains information about the configuration of an analyzer for an AWS organization or account.

      Returns union: either IResolvable or CfnAnalyzer.AnalyzerConfigurationProperty

    • setAnalyzerConfiguration

      @Stability(Stable) public void setAnalyzerConfiguration(@Nullable IResolvable value)
      Contains information about the configuration of an analyzer for an AWS organization or account.

    • setAnalyzerConfiguration

      @Stability(Stable) public void setAnalyzerConfiguration(@Nullable CfnAnalyzer.AnalyzerConfigurationProperty value)
      Contains information about the configuration of an analyzer for an AWS organization or account.

    • getAnalyzerName

      @Stability(Stable) @Nullable public String getAnalyzerName()
      The name of the analyzer.

    • setAnalyzerName

      @Stability(Stable) public void setAnalyzerName(@Nullable String value)
      The name of the analyzer.

    • getArchiveRules

      @Stability(Stable) @Nullable public Object getArchiveRules()
      Specifies the archive rules to add for the analyzer.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnAnalyzer.ArchiveRuleProperty>

    • setArchiveRules

      @Stability(Stable) public void setArchiveRules(@Nullable IResolvable value)
      Specifies the archive rules to add for the analyzer.

    • setArchiveRules

      @Stability(Stable) public void setArchiveRules(@Nullable List<Object> value)
      Specifies the archive rules to add for the analyzer.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      An array of key-value pairs to apply to the analyzer.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      An array of key-value pairs to apply to the analyzer.