Package com.pulumi.aws.accessanalyzer

Class Analyzer

  • public class Analyzer
extends com.pulumi.resources.CustomResource
    Manages an Access Analyzer Analyzer. More information can be found in the [Access Analyzer User Guide](https://docs.aws.amazon.com/IAM/latest/UserGuide/what-is-access-analyzer.html). ## Example Usage ### Account Analyzer 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.accessanalyzer.Analyzer;
 import com.pulumi.aws.accessanalyzer.AnalyzerArgs;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Map;
 import java.io.File;
 import java.nio.file.Files;
 import java.nio.file.Paths;
 
 public class App {
     public static void main(String[] args) {
         Pulumi.run(App::stack);
     }
 
     public static void stack(Context ctx) {
         var example = new Analyzer("example", AnalyzerArgs.builder()
             .analyzerName("example")
             .build());
 
     }
 }
    ### Organization Analyzer 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.organizations.Organization;
 import com.pulumi.aws.organizations.OrganizationArgs;
 import com.pulumi.aws.accessanalyzer.Analyzer;
 import com.pulumi.aws.accessanalyzer.AnalyzerArgs;
 import com.pulumi.resources.CustomResourceOptions;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Map;
 import java.io.File;
 import java.nio.file.Files;
 import java.nio.file.Paths;
 
 public class App {
     public static void main(String[] args) {
         Pulumi.run(App::stack);
     }
 
     public static void stack(Context ctx) {
         var example = new Organization("example", OrganizationArgs.builder()
             .awsServiceAccessPrincipals("access-analyzer.amazonaws.com")
             .build());
 
         var exampleAnalyzer = new Analyzer("exampleAnalyzer", AnalyzerArgs.builder()
             .analyzerName("example")
             .type("ORGANIZATION")
             .build(), CustomResourceOptions.builder()
                 .dependsOn(example)
                 .build());
 
     }
 }
    ### Organization Unused Access Analyzer With Analysis Rule 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.accessanalyzer.Analyzer;
 import com.pulumi.aws.accessanalyzer.AnalyzerArgs;
 import com.pulumi.aws.accessanalyzer.inputs.AnalyzerConfigurationArgs;
 import com.pulumi.aws.accessanalyzer.inputs.AnalyzerConfigurationUnusedAccessArgs;
 import com.pulumi.aws.accessanalyzer.inputs.AnalyzerConfigurationUnusedAccessAnalysisRuleArgs;
 import com.pulumi.aws.accessanalyzer.inputs.AnalyzerConfigurationUnusedAccessAnalysisRuleExclusionArgs;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Map;
 import java.io.File;
 import java.nio.file.Files;
 import java.nio.file.Paths;
 
 public class App {
     public static void main(String[] args) {
         Pulumi.run(App::stack);
     }
 
     public static void stack(Context ctx) {
         var example = new Analyzer("example", AnalyzerArgs.builder()
             .configuration(AnalyzerConfigurationArgs.builder()
                 .unusedAccess(AnalyzerConfigurationUnusedAccessArgs.builder()
                     .analysisRule(AnalyzerConfigurationUnusedAccessAnalysisRuleArgs.builder()
                         .exclusions(                        
                             AnalyzerConfigurationUnusedAccessAnalysisRuleExclusionArgs.builder()
                                 .accountIds(                                
                                     "123456789012",
                                     "234567890123")
                                 .build(),
                             AnalyzerConfigurationUnusedAccessAnalysisRuleExclusionArgs.builder()
                                 .resourceTags(                                
                                     Map.of("key1", "value1"),
                                     Map.of("key2", "value2"))
                                 .build())
                         .build())
                     .unusedAccessAge(180)
                     .build())
                 .build())
             .analyzerName("example")
             .type("ORGANIZATION_UNUSED_ACCESS")
             .build());
 
     }
 }
    ### Account Internal Access Analyzer by Resource Types 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.accessanalyzer.Analyzer;
 import com.pulumi.aws.accessanalyzer.AnalyzerArgs;
 import com.pulumi.aws.accessanalyzer.inputs.AnalyzerConfigurationArgs;
 import com.pulumi.aws.accessanalyzer.inputs.AnalyzerConfigurationInternalAccessArgs;
 import com.pulumi.aws.accessanalyzer.inputs.AnalyzerConfigurationInternalAccessAnalysisRuleArgs;
 import com.pulumi.aws.accessanalyzer.inputs.AnalyzerConfigurationInternalAccessAnalysisRuleInclusionArgs;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Map;
 import java.io.File;
 import java.nio.file.Files;
 import java.nio.file.Paths;
 
 public class App {
     public static void main(String[] args) {
         Pulumi.run(App::stack);
     }
 
     public static void stack(Context ctx) {
         var test = new Analyzer("test", AnalyzerArgs.builder()
             .configuration(AnalyzerConfigurationArgs.builder()
                 .internalAccess(AnalyzerConfigurationInternalAccessArgs.builder()
                     .analysisRule(AnalyzerConfigurationInternalAccessAnalysisRuleArgs.builder()
                         .inclusions(AnalyzerConfigurationInternalAccessAnalysisRuleInclusionArgs.builder()
                             .resourceTypes(                            
                                 "AWS::S3::Bucket",
                                 "AWS::RDS::DBSnapshot",
                                 "AWS::DynamoDB::Table")
                             .build())
                         .build())
                     .build())
                 .build())
             .analyzerName("example")
             .type("ORGANIZATION_INTERNAL_ACCESS")
             .build());
 
     }
 }
    ### Organization Internal Access Analyzer by Account ID and Resource ARN 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.accessanalyzer.Analyzer;
 import com.pulumi.aws.accessanalyzer.AnalyzerArgs;
 import com.pulumi.aws.accessanalyzer.inputs.AnalyzerConfigurationArgs;
 import com.pulumi.aws.accessanalyzer.inputs.AnalyzerConfigurationInternalAccessArgs;
 import com.pulumi.aws.accessanalyzer.inputs.AnalyzerConfigurationInternalAccessAnalysisRuleArgs;
 import com.pulumi.aws.accessanalyzer.inputs.AnalyzerConfigurationInternalAccessAnalysisRuleInclusionArgs;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Map;
 import java.io.File;
 import java.nio.file.Files;
 import java.nio.file.Paths;
 
 public class App {
     public static void main(String[] args) {
         Pulumi.run(App::stack);
     }
 
     public static void stack(Context ctx) {
         var test = new Analyzer("test", AnalyzerArgs.builder()
             .configuration(AnalyzerConfigurationArgs.builder()
                 .internalAccess(AnalyzerConfigurationInternalAccessArgs.builder()
                     .analysisRule(AnalyzerConfigurationInternalAccessAnalysisRuleArgs.builder()
                         .inclusions(AnalyzerConfigurationInternalAccessAnalysisRuleInclusionArgs.builder()
                             .accountIds("123456789012")
                             .resourceArns("arn:aws:s3:::my-example-bucket")
                             .build())
                         .build())
                     .build())
                 .build())
             .analyzerName("example")
             .type("ORGANIZATION_INTERNAL_ACCESS")
             .build());
 
     }
 }
    ## Import Using `pulumi import`, import Access Analyzer Analyzers using the `analyzerName`. For example: ```sh $ pulumi import aws:accessanalyzer/analyzer:Analyzer example example ```

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Constructor Summary

      Constructors 
      Constructor Description
      Analyzer​(java.lang.String name)  
      Analyzer​(java.lang.String name, AnalyzerArgs args)  
      Analyzer​(java.lang.String name, AnalyzerArgs args, com.pulumi.resources.CustomResourceOptions options)  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> analyzerName()  
      com.pulumi.core.Output<java.lang.String> arn()  
      com.pulumi.core.Output<java.util.Optional<AnalyzerConfiguration>> configuration()  
      static Analyzer get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, AnalyzerState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> type()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • Analyzer

        public Analyzer​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • Analyzer

        public Analyzer​(java.lang.String name,
                AnalyzerArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • Analyzer

        public Analyzer​(java.lang.String name,
                AnalyzerArgs args,
                @Nullable
                com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • analyzerName

        public com.pulumi.core.Output<java.lang.String> analyzerName()
        Returns:
        Name of the Analyzer. The following arguments are optional:

      • arn

        public com.pulumi.core.Output<java.lang.String> arn()
        Returns:
        ARN of the Analyzer.

      • configuration

        public com.pulumi.core.Output<java.util.Optional<AnalyzerConfiguration>> configuration()
        Returns:
        A block that specifies the configuration of the analyzer. See `configuration` Block for details.

      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        Key-value map of resource tags. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.

      • tagsAll

        public com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()
        Returns:
        Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.

      • type

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> type()
        Returns:
        Type that represents the zone of trust or scope for the analyzer. Valid values are `ACCOUNT`, `ACCOUNT_INTERNAL_ACCESS`, `ACCOUNT_UNUSED_ACCESS`, `ORGANIZATION`, `ORGANIZATION_INTERNAL_ACCESS`, `ORGANIZATION_UNUSED_ACCESS`. Defaults to `ACCOUNT`.

      • get

        public static Analyzer get​(java.lang.String name,
                           com.pulumi.core.Output<java.lang.String> id,
                           @Nullable
                           AnalyzerState state,
                           @Nullable
                           com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.