1. Docs
  2. Reference
  3. API
  4. @pulumi/aws
  5. macie

Module macie

This page documents the language specification for the aws package. If you're looking for help working with the inputs, outputs, or functions of aws resources in a Pulumi program, please see the resource documentation for examples and API reference.

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-aws repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-aws repo.

Resources

Others

Resources

Resource MemberAccountAssociation

class MemberAccountAssociation extends CustomResource

NOTE: This resource interacts with Amazon Macie Classic. Macie Classic cannot be activated in new accounts. See the FAQ for more details.

Associates an AWS account with Amazon Macie as a member account.

NOTE: Before using Amazon Macie for the first time it must be enabled manually. Instructions are here.

Example Usage

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

const example = new aws.macie.MemberAccountAssociation("example", {
    memberAccountId: "123456789012",
});

constructor

new MemberAccountAssociation(name: string, args: MemberAccountAssociationArgs, opts?: pulumi.CustomResourceOptions)

Create a MemberAccountAssociation resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: MemberAccountAssociationState, opts?: pulumi.CustomResourceOptions): MemberAccountAssociation

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is MemberAccountAssociation

Returns true if the given object is an instance of MemberAccountAssociation. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property memberAccountId

public memberAccountId: pulumi.Output<string>;

The ID of the AWS account that you want to associate with Amazon Macie as a member account.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource S3BucketAssociation

class S3BucketAssociation extends CustomResource

NOTE: This resource interacts with Amazon Macie Classic. Macie Classic cannot be activated in new accounts. See the FAQ for more details.

Associates an S3 resource with Amazon Macie for monitoring and data classification.

NOTE: Before using Amazon Macie for the first time it must be enabled manually. Instructions are here.

Example Usage

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

const example = new aws.macie.S3BucketAssociation("example", {
    bucketName: "tf-macie-example",
    classificationType: {
        oneTime: "FULL",
    },
    prefix: "data",
});

constructor

new S3BucketAssociation(name: string, args: S3BucketAssociationArgs, opts?: pulumi.CustomResourceOptions)

Create a S3BucketAssociation resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: S3BucketAssociationState, opts?: pulumi.CustomResourceOptions): S3BucketAssociation

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is S3BucketAssociation

Returns true if the given object is an instance of S3BucketAssociation. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property bucketName

public bucketName: pulumi.Output<string>;

The name of the S3 bucket that you want to associate with Amazon Macie.

property classificationType

public classificationType: pulumi.Output<S3BucketAssociationClassificationType>;

The configuration of how Amazon Macie classifies the S3 objects.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property memberAccountId

public memberAccountId: pulumi.Output<string | undefined>;

The ID of the Amazon Macie member account whose S3 resources you want to associate with Macie. If memberAccountId isn’t specified, the action associates specified S3 resources with Macie for the current master account.

property prefix

public prefix: pulumi.Output<string | undefined>;

Object key prefix identifying one or more S3 objects to which the association applies.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Others

interface MemberAccountAssociationArgs

interface MemberAccountAssociationArgs

The set of arguments for constructing a MemberAccountAssociation resource.

property memberAccountId

memberAccountId: pulumi.Input<string>;

The ID of the AWS account that you want to associate with Amazon Macie as a member account.

interface MemberAccountAssociationState

interface MemberAccountAssociationState

Input properties used for looking up and filtering MemberAccountAssociation resources.

property memberAccountId

memberAccountId?: pulumi.Input<string>;

The ID of the AWS account that you want to associate with Amazon Macie as a member account.

interface S3BucketAssociationArgs

interface S3BucketAssociationArgs

The set of arguments for constructing a S3BucketAssociation resource.

property bucketName

bucketName: pulumi.Input<string>;

The name of the S3 bucket that you want to associate with Amazon Macie.

property classificationType

classificationType?: pulumi.Input<S3BucketAssociationClassificationType>;

The configuration of how Amazon Macie classifies the S3 objects.

property memberAccountId

memberAccountId?: pulumi.Input<string>;

The ID of the Amazon Macie member account whose S3 resources you want to associate with Macie. If memberAccountId isn’t specified, the action associates specified S3 resources with Macie for the current master account.

property prefix

prefix?: pulumi.Input<string>;

Object key prefix identifying one or more S3 objects to which the association applies.

interface S3BucketAssociationState

interface S3BucketAssociationState

Input properties used for looking up and filtering S3BucketAssociation resources.

property bucketName

bucketName?: pulumi.Input<string>;

The name of the S3 bucket that you want to associate with Amazon Macie.

property classificationType

classificationType?: pulumi.Input<S3BucketAssociationClassificationType>;

The configuration of how Amazon Macie classifies the S3 objects.

property memberAccountId

memberAccountId?: pulumi.Input<string>;

The ID of the Amazon Macie member account whose S3 resources you want to associate with Macie. If memberAccountId isn’t specified, the action associates specified S3 resources with Macie for the current master account.

property prefix

prefix?: pulumi.Input<string>;

Object key prefix identifying one or more S3 objects to which the association applies.