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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:35.965Z")
 @Stability(value=Stable)
public class CfnAnalyzer
extends CfnResource
implements IInspectable

A CloudFormation `AWS::AccessAnalyzer::Analyzer`.

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
         .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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnAnalyzer.ArchiveRuleProperty The criteria for an archive rule.
static class	CfnAnalyzer.Builder A fluent builder for CfnAnalyzer.
static interface	CfnAnalyzer.FilterProperty The criteria that defines the rule.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnAnalyzer(software.constructs.Construct scope, String id, CfnAnalyzerProps props) Create a new `AWS::AccessAnalyzer::Analyzer`.
protected	CfnAnalyzer(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnAnalyzer(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAnalyzerName() The name of the analyzer.
Object	getArchiveRules() Specifies the archive rules to add for the analyzer.
String	getAttrArn()
protected Map<String,Object>	getCfnProperties()
TagManager	getTags() The tags to apply to the analyzer.
String	getType() The type represents the zone of trust for the analyzer.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAnalyzerName(String value) The name of the analyzer.
void	setArchiveRules(IResolvable value) Specifies the archive rules to add for the analyzer.
void	setArchiveRules(List<Object> value) Specifies the archive rules to add for the analyzer.
void	setType(String value) The type represents the zone of trust for the analyzer.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnAnalyzer

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

CfnAnalyzer

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

CfnAnalyzer

@Stability(value=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 - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=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(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(value=Stable)
 @NotNull
public String getAttrArn()

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

The tags to apply to the analyzer.

getType

@Stability(value=Stable)
 @NotNull
public String getType()

The type represents the zone of trust for the analyzer.

Allowed Values : ACCOUNT | ORGANIZATION

setType

@Stability(value=Stable)
public void setType(@NotNull
                                             String value)

The type represents the zone of trust for the analyzer.

Allowed Values : ACCOUNT | ORGANIZATION

getAnalyzerName

@Stability(value=Stable)
 @Nullable
public String getAnalyzerName()

The name of the analyzer.

setAnalyzerName

@Stability(value=Stable)
public void setAnalyzerName(@Nullable
                                                     String value)

The name of the analyzer.

getArchiveRules

@Stability(value=Stable)
 @Nullable
public Object getArchiveRules()

Specifies the archive rules to add for the analyzer.

setArchiveRules

@Stability(value=Stable)
public void setArchiveRules(@Nullable
                                                     IResolvable value)

Specifies the archive rules to add for the analyzer.

setArchiveRules

@Stability(value=Stable)
public void setArchiveRules(@Nullable
                                                     List<Object> value)

Specifies the archive rules to add for the analyzer.