1. Packages
  2. AWS Classic
  3. API Docs
  4. accessanalyzer
  5. Analyzer

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.12.2 published on Wednesday, Nov 29, 2023 by Pulumi

aws.accessanalyzer.Analyzer

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.12.2 published on Wednesday, Nov 29, 2023 by Pulumi

    Manages an Access Analyzer Analyzer. More information can be found in the Access Analyzer User Guide.

    Example Usage

    Account Analyzer

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Aws.AccessAnalyzer.Analyzer("example", new()
        {
            AnalyzerName = "example",
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/accessanalyzer"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := accessanalyzer.NewAnalyzer(ctx, "example", &accessanalyzer.AnalyzerArgs{
    			AnalyzerName: pulumi.String("example"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    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.List;
    import java.util.ArrayList;
    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());
    
        }
    }
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.accessanalyzer.Analyzer("example", analyzer_name="example")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = new aws.accessanalyzer.Analyzer("example", {analyzerName: "example"});
    
    resources:
      example:
        type: aws:accessanalyzer:Analyzer
        properties:
          analyzerName: example
    

    Organization Analyzer

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var exampleOrganization = new Aws.Organizations.Organization("exampleOrganization", new()
        {
            AwsServiceAccessPrincipals = new[]
            {
                "access-analyzer.amazonaws.com",
            },
        });
    
        var exampleAnalyzer = new Aws.AccessAnalyzer.Analyzer("exampleAnalyzer", new()
        {
            AnalyzerName = "example",
            Type = "ORGANIZATION",
        }, new CustomResourceOptions
        {
            DependsOn = new[]
            {
                exampleOrganization,
            },
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/accessanalyzer"
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/organizations"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		exampleOrganization, err := organizations.NewOrganization(ctx, "exampleOrganization", &organizations.OrganizationArgs{
    			AwsServiceAccessPrincipals: pulumi.StringArray{
    				pulumi.String("access-analyzer.amazonaws.com"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		_, err = accessanalyzer.NewAnalyzer(ctx, "exampleAnalyzer", &accessanalyzer.AnalyzerArgs{
    			AnalyzerName: pulumi.String("example"),
    			Type:         pulumi.String("ORGANIZATION"),
    		}, pulumi.DependsOn([]pulumi.Resource{
    			exampleOrganization,
    		}))
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    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.List;
    import java.util.ArrayList;
    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 exampleOrganization = new Organization("exampleOrganization", OrganizationArgs.builder()        
                .awsServiceAccessPrincipals("access-analyzer.amazonaws.com")
                .build());
    
            var exampleAnalyzer = new Analyzer("exampleAnalyzer", AnalyzerArgs.builder()        
                .analyzerName("example")
                .type("ORGANIZATION")
                .build(), CustomResourceOptions.builder()
                    .dependsOn(exampleOrganization)
                    .build());
    
        }
    }
    
    import pulumi
    import pulumi_aws as aws
    
    example_organization = aws.organizations.Organization("exampleOrganization", aws_service_access_principals=["access-analyzer.amazonaws.com"])
    example_analyzer = aws.accessanalyzer.Analyzer("exampleAnalyzer",
        analyzer_name="example",
        type="ORGANIZATION",
        opts=pulumi.ResourceOptions(depends_on=[example_organization]))
    
    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const exampleOrganization = new aws.organizations.Organization("exampleOrganization", {awsServiceAccessPrincipals: ["access-analyzer.amazonaws.com"]});
    const exampleAnalyzer = new aws.accessanalyzer.Analyzer("exampleAnalyzer", {
        analyzerName: "example",
        type: "ORGANIZATION",
    }, {
        dependsOn: [exampleOrganization],
    });
    
    resources:
      exampleOrganization:
        type: aws:organizations:Organization
        properties:
          awsServiceAccessPrincipals:
            - access-analyzer.amazonaws.com
      exampleAnalyzer:
        type: aws:accessanalyzer:Analyzer
        properties:
          analyzerName: example
          type: ORGANIZATION
        options:
          dependson:
            - ${exampleOrganization}
    

    Create Analyzer Resource

    new Analyzer(name: string, args: AnalyzerArgs, opts?: CustomResourceOptions);
    @overload
    def Analyzer(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 analyzer_name: Optional[str] = None,
                 tags: Optional[Mapping[str, str]] = None,
                 type: Optional[str] = None)
    @overload
    def Analyzer(resource_name: str,
                 args: AnalyzerArgs,
                 opts: Optional[ResourceOptions] = None)
    func NewAnalyzer(ctx *Context, name string, args AnalyzerArgs, opts ...ResourceOption) (*Analyzer, error)
    public Analyzer(string name, AnalyzerArgs args, CustomResourceOptions? opts = null)
    public Analyzer(String name, AnalyzerArgs args)
    public Analyzer(String name, AnalyzerArgs args, CustomResourceOptions options)
    
    type: aws:accessanalyzer:Analyzer
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args AnalyzerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args AnalyzerArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args AnalyzerArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AnalyzerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AnalyzerArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Analyzer Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Analyzer resource accepts the following input properties:

    AnalyzerName string

    Name of the Analyzer.

    The following arguments are optional:

    Tags Dictionary<string, string>

    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    Type string

    Type of Analyzer. Valid values are ACCOUNT or ORGANIZATION. Defaults to ACCOUNT.

    AnalyzerName string

    Name of the Analyzer.

    The following arguments are optional:

    Tags map[string]string

    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    Type string

    Type of Analyzer. Valid values are ACCOUNT or ORGANIZATION. Defaults to ACCOUNT.

    analyzerName String

    Name of the Analyzer.

    The following arguments are optional:

    tags Map<String,String>

    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    type String

    Type of Analyzer. Valid values are ACCOUNT or ORGANIZATION. Defaults to ACCOUNT.

    analyzerName string

    Name of the Analyzer.

    The following arguments are optional:

    tags {[key: string]: string}

    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    type string

    Type of Analyzer. Valid values are ACCOUNT or ORGANIZATION. Defaults to ACCOUNT.

    analyzer_name str

    Name of the Analyzer.

    The following arguments are optional:

    tags Mapping[str, str]

    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    type str

    Type of Analyzer. Valid values are ACCOUNT or ORGANIZATION. Defaults to ACCOUNT.

    analyzerName String

    Name of the Analyzer.

    The following arguments are optional:

    tags Map<String>

    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    type String

    Type of Analyzer. Valid values are ACCOUNT or ORGANIZATION. Defaults to ACCOUNT.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Analyzer resource produces the following output properties:

    Arn string

    ARN of the Analyzer.

    Id string

    The provider-assigned unique ID for this managed resource.

    TagsAll Dictionary<string, string>

    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    Arn string

    ARN of the Analyzer.

    Id string

    The provider-assigned unique ID for this managed resource.

    TagsAll map[string]string

    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    arn String

    ARN of the Analyzer.

    id String

    The provider-assigned unique ID for this managed resource.

    tagsAll Map<String,String>

    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    arn string

    ARN of the Analyzer.

    id string

    The provider-assigned unique ID for this managed resource.

    tagsAll {[key: string]: string}

    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    arn str

    ARN of the Analyzer.

    id str

    The provider-assigned unique ID for this managed resource.

    tags_all Mapping[str, str]

    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    arn String

    ARN of the Analyzer.

    id String

    The provider-assigned unique ID for this managed resource.

    tagsAll Map<String>

    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    Look up Existing Analyzer Resource

    Get an existing Analyzer resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: AnalyzerState, opts?: CustomResourceOptions): Analyzer
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            analyzer_name: Optional[str] = None,
            arn: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None,
            tags_all: Optional[Mapping[str, str]] = None,
            type: Optional[str] = None) -> Analyzer
    func GetAnalyzer(ctx *Context, name string, id IDInput, state *AnalyzerState, opts ...ResourceOption) (*Analyzer, error)
    public static Analyzer Get(string name, Input<string> id, AnalyzerState? state, CustomResourceOptions? opts = null)
    public static Analyzer get(String name, Output<String> id, AnalyzerState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AnalyzerName string

    Name of the Analyzer.

    The following arguments are optional:

    Arn string

    ARN of the Analyzer.

    Tags Dictionary<string, string>

    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    TagsAll Dictionary<string, string>

    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    Type string

    Type of Analyzer. Valid values are ACCOUNT or ORGANIZATION. Defaults to ACCOUNT.

    AnalyzerName string

    Name of the Analyzer.

    The following arguments are optional:

    Arn string

    ARN of the Analyzer.

    Tags map[string]string

    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    TagsAll map[string]string

    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    Type string

    Type of Analyzer. Valid values are ACCOUNT or ORGANIZATION. Defaults to ACCOUNT.

    analyzerName String

    Name of the Analyzer.

    The following arguments are optional:

    arn String

    ARN of the Analyzer.

    tags Map<String,String>

    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    tagsAll Map<String,String>

    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    type String

    Type of Analyzer. Valid values are ACCOUNT or ORGANIZATION. Defaults to ACCOUNT.

    analyzerName string

    Name of the Analyzer.

    The following arguments are optional:

    arn string

    ARN of the Analyzer.

    tags {[key: string]: string}

    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    tagsAll {[key: string]: string}

    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    type string

    Type of Analyzer. Valid values are ACCOUNT or ORGANIZATION. Defaults to ACCOUNT.

    analyzer_name str

    Name of the Analyzer.

    The following arguments are optional:

    arn str

    ARN of the Analyzer.

    tags Mapping[str, str]

    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    tags_all Mapping[str, str]

    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    type str

    Type of Analyzer. Valid values are ACCOUNT or ORGANIZATION. Defaults to ACCOUNT.

    analyzerName String

    Name of the Analyzer.

    The following arguments are optional:

    arn String

    ARN of the Analyzer.

    tags Map<String>

    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    tagsAll Map<String>

    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    type String

    Type of Analyzer. Valid values are ACCOUNT or ORGANIZATION. Defaults to ACCOUNT.

    Import

    Using pulumi import, import Access Analyzer Analyzers using the analyzer_name. For example:

     $ pulumi import aws:accessanalyzer/analyzer:Analyzer example example
    

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes

    This Pulumi package is based on the aws Terraform Provider.

    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.12.2 published on Wednesday, Nov 29, 2023 by Pulumi