ArchiveRule class

Resource for managing an AWS AccessAnalyzer Archive Rule.

Example Usage

Basic Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.accessanalyzer.ArchiveRule("example", {
    filters: [
        {
            criteria: "condition.aws:UserId",
            eqs: ["userid"],
        },
        {
            criteria: "error",
            exists: "true",
        },
        {
            criteria: "isPublic",
            eqs: ["false"],
        },
    ],
    analyzerName: "example-analyzer",
    ruleName: "example-rule",
});
import pulumi
import pulumi_aws as aws

example = aws.accessanalyzer.ArchiveRule("example",
    filters=[
        {
            "criteria": "condition.aws:UserId",
            "eqs": ["userid"],
        },
        {
            "criteria": "error",
            "exists": "true",
        },
        {
            "criteria": "isPublic",
            "eqs": ["false"],
        },
    ],
    analyzer_name="example-analyzer",
    rule_name="example-rule")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.AccessAnalyzer.ArchiveRule("example", new()
    {
        Filters = new[]
        {
            new Aws.AccessAnalyzer.Inputs.ArchiveRuleFilterArgs
            {
                Criteria = "condition.aws:UserId",
                Eqs = new[]
                {
                    "userid",
                },
            },
            new Aws.AccessAnalyzer.Inputs.ArchiveRuleFilterArgs
            {
                Criteria = "error",
                Exists = "true",
            },
            new Aws.AccessAnalyzer.Inputs.ArchiveRuleFilterArgs
            {
                Criteria = "isPublic",
                Eqs = new[]
                {
                    "false",
                },
            },
        },
        AnalyzerName = "example-analyzer",
        RuleName = "example-rule",
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/accessanalyzer"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := accessanalyzer.NewArchiveRule(ctx, "example", &accessanalyzer.ArchiveRuleArgs{
			Filters: accessanalyzer.ArchiveRuleFilterArray{
				&accessanalyzer.ArchiveRuleFilterArgs{
					Criteria: pulumi.String("condition.aws:UserId"),
					Eqs: pulumi.StringArray{
						pulumi.String("userid"),
					},
				},
				&accessanalyzer.ArchiveRuleFilterArgs{
					Criteria: pulumi.String("error"),
					Exists:   pulumi.String("true"),
				},
				&accessanalyzer.ArchiveRuleFilterArgs{
					Criteria: pulumi.String("isPublic"),
					Eqs: pulumi.StringArray{
						pulumi.String("false"),
					},
				},
			},
			AnalyzerName: pulumi.String("example-analyzer"),
			RuleName:     pulumi.String("example-rule"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_accessanalyzer_archiverule" "example" {
  filters {
    criteria = "condition.aws:UserId"
    eqs      = ["userid"]
  }
  filters {
    criteria = "error"
    exists   = true
  }
  filters {
    criteria = "isPublic"
    eqs      = ["false"]
  }
  analyzer_name = "example-analyzer"
  rule_name     = "example-rule"
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.accessanalyzer.ArchiveRule;
import com.pulumi.aws.accessanalyzer.ArchiveRuleArgs;
import com.pulumi.aws.accessanalyzer.inputs.ArchiveRuleFilterArgs;
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 ArchiveRule("example", ArchiveRuleArgs.builder()
            .filters(
                ArchiveRuleFilterArgs.builder()
                    .criteria("condition.aws:UserId")
                    .eqs("userid")
                    .build(),
                ArchiveRuleFilterArgs.builder()
                    .criteria("error")
                    .exists("true")
                    .build(),
                ArchiveRuleFilterArgs.builder()
                    .criteria("isPublic")
                    .eqs("false")
                    .build())
            .analyzerName("example-analyzer")
            .ruleName("example-rule")
            .build());

    }
}
resources:
  example:
    type: aws:accessanalyzer:ArchiveRule
    properties:
      filters:
        - criteria: condition.aws:UserId
          eqs:
            - userid
        - criteria: error
          exists: true
        - criteria: isPublic
          eqs:
            - 'false'
      analyzerName: example-analyzer
      ruleName: example-rule

Import

Using pulumi import, import AccessAnalyzer ArchiveRule using the analyzer_name/rule_name. For example:

$ pulumi import aws:accessanalyzer/archiveRule:ArchiveRule example example-analyzer/example-rule

Constructors

ArchiveRule(String name, {ArchiveRuleArgs? args, CustomResourceOptions? options})
Creates a new ArchiveRule. name The Pulumi resource name. args Arguments used to configure this ArchiveRule. The set of arguments for ArchiveRule. options Resource options controlling this resource's behavior.
ArchiveRule.reference(String urn)
Creates a typed reference to an existing ArchiveRule resource.

Properties

analyzerName ↔ Output<String>
Analyzer name.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
filters ↔ Output<List<ArchiveRuleFilter>>
Filter criteria for the archive rule. See Filter for more details.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
ruleName ↔ Output<String>
Rule name.
latefinal
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {ArchiveRuleState? state, CustomResourceOptions? options}) → ArchiveRule
Gets an existing ArchiveRule resource's state with the given name and id.