Framework class

Resource for managing an AWS Audit Manager Framework.

Example Usage

Basic Usage

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

const test = new aws.auditmanager.Framework("test", {
    controlSets: [{
        controls: [
            {
                id: test1.id,
            },
            {
                id: test2.id,
            },
        ],
        name: "example",
    }],
    name: "example",
});
import pulumi
import pulumi_aws as aws

test = aws.auditmanager.Framework("test",
    control_sets=[{
        "controls": [
            {
                "id": test1["id"],
            },
            {
                "id": test2["id"],
            },
        ],
        "name": "example",
    }],
    name="example")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var test = new Aws.Auditmanager.Framework("test", new()
    {
        ControlSets = new[]
        {
            new Aws.Auditmanager.Inputs.FrameworkControlSetArgs
            {
                Controls = new[]
                {
                    new Aws.Auditmanager.Inputs.FrameworkControlSetControlArgs
                    {
                        Id = test1.Id,
                    },
                    new Aws.Auditmanager.Inputs.FrameworkControlSetControlArgs
                    {
                        Id = test2.Id,
                    },
                },
                Name = "example",
            },
        },
        Name = "example",
    });

});
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := auditmanager.NewFramework(ctx, "test", &auditmanager.FrameworkArgs{
			ControlSets: auditmanager.FrameworkControlSetArray{
				&auditmanager.FrameworkControlSetArgs{
					Controls: auditmanager.FrameworkControlSetControlArray{
						&auditmanager.FrameworkControlSetControlArgs{
							Id: pulumi.Any(test1.Id),
						},
						&auditmanager.FrameworkControlSetControlArgs{
							Id: pulumi.Any(test2.Id),
						},
					},
					Name: pulumi.String("example"),
				},
			},
			Name: pulumi.String("example"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_auditmanager_framework" "test" {
  control_sets {
    controls {
      id = test1.id
    }
    controls {
      id = test2.id
    }
    name = "example"
  }
  name = "example"
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.auditmanager.Framework;
import com.pulumi.aws.auditmanager.FrameworkArgs;
import com.pulumi.aws.auditmanager.inputs.FrameworkControlSetArgs;
import com.pulumi.aws.auditmanager.inputs.FrameworkControlSetControlArgs;
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 Framework("test", FrameworkArgs.builder()
            .controlSets(FrameworkControlSetArgs.builder()
                .controls(
                    FrameworkControlSetControlArgs.builder()
                        .id(test1.id())
                        .build(),
                    FrameworkControlSetControlArgs.builder()
                        .id(test2.id())
                        .build())
                .name("example")
                .build())
            .name("example")
            .build());

    }
}
resources:
  test:
    type: aws:auditmanager:Framework
    properties:
      controlSets:
        - controls:
            - id: ${test1.id}
            - id: ${test2.id}
          name: example
      name: example

Import

Identity Schema

Required

  • id (String) Unique identifier for the framework.

Optional

  • accountId (String) AWS Account where this resource is managed.
  • region (String) Region where this resource is managed.

Using pulumi import, import Audit Manager Framework using the framework id. For example:

$ pulumi import aws:auditmanager/framework:Framework example abc123-de45

Constructors

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

Properties

arn ↔ Output<String>
ARN of the framework.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
complianceType ↔ Output<String?>
Compliance type that the new custom framework supports, such as CIS or HIPAA.
latefinal
controlSets ↔ Output<List<FrameworkControlSet>?>
Configuration block(s) for the control sets that are associated with the framework. See controlSets Block below for details.
latefinal
description ↔ Output<String?>
Description of the framework.
latefinal
frameworkType ↔ Output<String>
Framework type, such as a custom framework or a standard framework.
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
name ↔ Output<String>
Name of the framework.
latefinal
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
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
tags ↔ Output<Map<String, String>?>
A map of tags to assign to the framework. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
latefinal
tagsAll ↔ Output<Map<String, String>>
latefinal
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, {FrameworkState? state, CustomResourceOptions? options}) → Framework
Gets an existing Framework resource's state with the given name and id.