Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. auditmanager
  5. Framework
AWS v6.75.0 published on Wednesday, Apr 2, 2025 by Pulumi
pulumi/pulumi-aws

aws.auditmanager.Framework

Explore with Pulumi AI

AWS v6.75.0 published on Wednesday, Apr 2, 2025 by Pulumi
pulumi/pulumi-aws

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", {
    name: "example",
    controlSets: [{
        name: "example",
        controls: [
            {
                id: test1.id,
            },
            {
                id: test2.id,
            },
        ],
    }],
});
Copy
import pulumi
import pulumi_aws as aws

test = aws.auditmanager.Framework("test",
    name="example",
    control_sets=[{
        "name": "example",
        "controls": [
            {
                "id": test1["id"],
            },
            {
                "id": test2["id"],
            },
        ],
    }])
Copy
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/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{
			Name: pulumi.String("example"),
			ControlSets: auditmanager.FrameworkControlSetArray{
				&auditmanager.FrameworkControlSetArgs{
					Name: pulumi.String("example"),
					Controls: auditmanager.FrameworkControlSetControlArray{
						&auditmanager.FrameworkControlSetControlArgs{
							Id: pulumi.Any(test1.Id),
						},
						&auditmanager.FrameworkControlSetControlArgs{
							Id: pulumi.Any(test2.Id),
						},
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
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()
    {
        Name = "example",
        ControlSets = new[]
        {
            new Aws.Auditmanager.Inputs.FrameworkControlSetArgs
            {
                Name = "example",
                Controls = new[]
                {
                    new Aws.Auditmanager.Inputs.FrameworkControlSetControlArgs
                    {
                        Id = test1.Id,
                    },
                    new Aws.Auditmanager.Inputs.FrameworkControlSetControlArgs
                    {
                        Id = test2.Id,
                    },
                },
            },
        },
    });

});
Copy
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 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 test = new Framework("test", FrameworkArgs.builder()
            .name("example")
            .controlSets(FrameworkControlSetArgs.builder()
                .name("example")
                .controls(                
                    FrameworkControlSetControlArgs.builder()
                        .id(test1.id())
                        .build(),
                    FrameworkControlSetControlArgs.builder()
                        .id(test2.id())
                        .build())
                .build())
            .build());

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

Create Framework Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Framework(name: string, args?: FrameworkArgs, opts?: CustomResourceOptions);
@overload
def Framework(resource_name: str,
              args: Optional[FrameworkArgs] = None,
              opts: Optional[ResourceOptions] = None)

@overload
def Framework(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              compliance_type: Optional[str] = None,
              control_sets: Optional[Sequence[FrameworkControlSetArgs]] = None,
              description: Optional[str] = None,
              name: Optional[str] = None,
              tags: Optional[Mapping[str, str]] = None)
func NewFramework(ctx *Context, name string, args *FrameworkArgs, opts ...ResourceOption) (*Framework, error)
public Framework(string name, FrameworkArgs? args = null, CustomResourceOptions? opts = null)
public Framework(String name, FrameworkArgs args)
public Framework(String name, FrameworkArgs args, CustomResourceOptions options)

type: aws:auditmanager:Framework
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args FrameworkArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args FrameworkArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args FrameworkArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args FrameworkArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. FrameworkArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var frameworkResource = new Aws.Auditmanager.Framework("frameworkResource", new()
{
    ComplianceType = "string",
    ControlSets = new[]
    {
        new Aws.Auditmanager.Inputs.FrameworkControlSetArgs
        {
            Name = "string",
            Controls = new[]
            {
                new Aws.Auditmanager.Inputs.FrameworkControlSetControlArgs
                {
                    Id = "string",
                },
            },
            Id = "string",
        },
    },
    Description = "string",
    Name = "string",
    Tags = 
    {
        { "string", "string" },
    },
});
Copy
example, err := auditmanager.NewFramework(ctx, "frameworkResource", &auditmanager.FrameworkArgs{
	ComplianceType: pulumi.String("string"),
	ControlSets: auditmanager.FrameworkControlSetArray{
		&auditmanager.FrameworkControlSetArgs{
			Name: pulumi.String("string"),
			Controls: auditmanager.FrameworkControlSetControlArray{
				&auditmanager.FrameworkControlSetControlArgs{
					Id: pulumi.String("string"),
				},
			},
			Id: pulumi.String("string"),
		},
	},
	Description: pulumi.String("string"),
	Name:        pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})
Copy
var frameworkResource = new Framework("frameworkResource", FrameworkArgs.builder()
    .complianceType("string")
    .controlSets(FrameworkControlSetArgs.builder()
        .name("string")
        .controls(FrameworkControlSetControlArgs.builder()
            .id("string")
            .build())
        .id("string")
        .build())
    .description("string")
    .name("string")
    .tags(Map.of("string", "string"))
    .build());
Copy
framework_resource = aws.auditmanager.Framework("frameworkResource",
    compliance_type="string",
    control_sets=[{
        "name": "string",
        "controls": [{
            "id": "string",
        }],
        "id": "string",
    }],
    description="string",
    name="string",
    tags={
        "string": "string",
    })
Copy
const frameworkResource = new aws.auditmanager.Framework("frameworkResource", {
    complianceType: "string",
    controlSets: [{
        name: "string",
        controls: [{
            id: "string",
        }],
        id: "string",
    }],
    description: "string",
    name: "string",
    tags: {
        string: "string",
    },
});
Copy
type: aws:auditmanager:Framework
properties:
    complianceType: string
    controlSets:
        - controls:
            - id: string
          id: string
          name: string
    description: string
    name: string
    tags:
        string: string
Copy

Framework Resource Properties

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

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Framework resource accepts the following input properties:

ComplianceType string
Compliance type that the new custom framework supports, such as CIS or HIPAA.
ControlSets List<FrameworkControlSet>

Configuration block(s) for the control sets that are associated with the framework. See control_sets Block below for details.

The following arguments are optional:

Description string
Description of the framework.
Name string
Name of the framework.
Tags Dictionary<string, string>
A map of tags to assign to the framework. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
ComplianceType string
Compliance type that the new custom framework supports, such as CIS or HIPAA.
ControlSets []FrameworkControlSetArgs

Configuration block(s) for the control sets that are associated with the framework. See control_sets Block below for details.

The following arguments are optional:

Description string
Description of the framework.
Name string
Name of the framework.
Tags map[string]string
A map of tags to assign to the framework. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
complianceType String
Compliance type that the new custom framework supports, such as CIS or HIPAA.
controlSets List<FrameworkControlSet>

Configuration block(s) for the control sets that are associated with the framework. See control_sets Block below for details.

The following arguments are optional:

description String
Description of the framework.
name String
Name of the framework.
tags Map<String,String>
A map of tags to assign to the framework. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
complianceType string
Compliance type that the new custom framework supports, such as CIS or HIPAA.
controlSets FrameworkControlSet[]

Configuration block(s) for the control sets that are associated with the framework. See control_sets Block below for details.

The following arguments are optional:

description string
Description of the framework.
name string
Name of the framework.
tags {[key: string]: string}
A map of tags to assign to the framework. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
compliance_type str
Compliance type that the new custom framework supports, such as CIS or HIPAA.
control_sets Sequence[FrameworkControlSetArgs]

Configuration block(s) for the control sets that are associated with the framework. See control_sets Block below for details.

The following arguments are optional:

description str
Description of the framework.
name str
Name of the framework.
tags Mapping[str, str]
A map of tags to assign to the framework. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
complianceType String
Compliance type that the new custom framework supports, such as CIS or HIPAA.
controlSets List<Property Map>

Configuration block(s) for the control sets that are associated with the framework. See control_sets Block below for details.

The following arguments are optional:

description String
Description of the framework.
name String
Name of the framework.
tags Map<String>
A map of tags to assign to the framework. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

Outputs

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

Arn string
Amazon Resource Name (ARN) of the framework.

  • control_sets[*].id - Unique identifier for the framework control set.
FrameworkType string
Framework type, such as a custom framework or a standard framework.
Id string
The provider-assigned unique ID for this managed resource.
TagsAll Dictionary<string, string>

Deprecated: Please use tags instead.

Arn string
Amazon Resource Name (ARN) of the framework.

  • control_sets[*].id - Unique identifier for the framework control set.
FrameworkType string
Framework type, such as a custom framework or a standard framework.
Id string
The provider-assigned unique ID for this managed resource.
TagsAll map[string]string

Deprecated: Please use tags instead.

arn String
Amazon Resource Name (ARN) of the framework.

  • control_sets[*].id - Unique identifier for the framework control set.
frameworkType String
Framework type, such as a custom framework or a standard framework.
id String
The provider-assigned unique ID for this managed resource.
tagsAll Map<String,String>

Deprecated: Please use tags instead.

arn string
Amazon Resource Name (ARN) of the framework.

  • control_sets[*].id - Unique identifier for the framework control set.
frameworkType string
Framework type, such as a custom framework or a standard framework.
id string
The provider-assigned unique ID for this managed resource.
tagsAll {[key: string]: string}

Deprecated: Please use tags instead.

arn str
Amazon Resource Name (ARN) of the framework.

  • control_sets[*].id - Unique identifier for the framework control set.
framework_type str
Framework type, such as a custom framework or a standard framework.
id str
The provider-assigned unique ID for this managed resource.
tags_all Mapping[str, str]

Deprecated: Please use tags instead.

arn String
Amazon Resource Name (ARN) of the framework.

  • control_sets[*].id - Unique identifier for the framework control set.
frameworkType String
Framework type, such as a custom framework or a standard framework.
id String
The provider-assigned unique ID for this managed resource.
tagsAll Map<String>

Deprecated: Please use tags instead.

Look up Existing Framework Resource

Get an existing Framework 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?: FrameworkState, opts?: CustomResourceOptions): Framework
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        compliance_type: Optional[str] = None,
        control_sets: Optional[Sequence[FrameworkControlSetArgs]] = None,
        description: Optional[str] = None,
        framework_type: Optional[str] = None,
        name: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None) -> Framework
func GetFramework(ctx *Context, name string, id IDInput, state *FrameworkState, opts ...ResourceOption) (*Framework, error)
public static Framework Get(string name, Input<string> id, FrameworkState? state, CustomResourceOptions? opts = null)
public static Framework get(String name, Output<String> id, FrameworkState state, CustomResourceOptions options)
resources:  _:    type: aws:auditmanager:Framework    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
Arn string
Amazon Resource Name (ARN) of the framework.

  • control_sets[*].id - Unique identifier for the framework control set.
ComplianceType string
Compliance type that the new custom framework supports, such as CIS or HIPAA.
ControlSets List<FrameworkControlSet>

Configuration block(s) for the control sets that are associated with the framework. See control_sets Block below for details.

The following arguments are optional:

Description string
Description of the framework.
FrameworkType string
Framework type, such as a custom framework or a standard framework.
Name string
Name of the framework.
Tags Dictionary<string, string>
A map of tags to assign to the framework. 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>

Deprecated: Please use tags instead.

Arn string
Amazon Resource Name (ARN) of the framework.

  • control_sets[*].id - Unique identifier for the framework control set.
ComplianceType string
Compliance type that the new custom framework supports, such as CIS or HIPAA.
ControlSets []FrameworkControlSetArgs

Configuration block(s) for the control sets that are associated with the framework. See control_sets Block below for details.

The following arguments are optional:

Description string
Description of the framework.
FrameworkType string
Framework type, such as a custom framework or a standard framework.
Name string
Name of the framework.
Tags map[string]string
A map of tags to assign to the framework. 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

Deprecated: Please use tags instead.

arn String
Amazon Resource Name (ARN) of the framework.

  • control_sets[*].id - Unique identifier for the framework control set.
complianceType String
Compliance type that the new custom framework supports, such as CIS or HIPAA.
controlSets List<FrameworkControlSet>

Configuration block(s) for the control sets that are associated with the framework. See control_sets Block below for details.

The following arguments are optional:

description String
Description of the framework.
frameworkType String
Framework type, such as a custom framework or a standard framework.
name String
Name of the framework.
tags Map<String,String>
A map of tags to assign to the framework. 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>

Deprecated: Please use tags instead.

arn string
Amazon Resource Name (ARN) of the framework.

  • control_sets[*].id - Unique identifier for the framework control set.
complianceType string
Compliance type that the new custom framework supports, such as CIS or HIPAA.
controlSets FrameworkControlSet[]

Configuration block(s) for the control sets that are associated with the framework. See control_sets Block below for details.

The following arguments are optional:

description string
Description of the framework.
frameworkType string
Framework type, such as a custom framework or a standard framework.
name string
Name of the framework.
tags {[key: string]: string}
A map of tags to assign to the framework. 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}

Deprecated: Please use tags instead.

arn str
Amazon Resource Name (ARN) of the framework.

  • control_sets[*].id - Unique identifier for the framework control set.
compliance_type str
Compliance type that the new custom framework supports, such as CIS or HIPAA.
control_sets Sequence[FrameworkControlSetArgs]

Configuration block(s) for the control sets that are associated with the framework. See control_sets Block below for details.

The following arguments are optional:

description str
Description of the framework.
framework_type str
Framework type, such as a custom framework or a standard framework.
name str
Name of the framework.
tags Mapping[str, str]
A map of tags to assign to the framework. 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]

Deprecated: Please use tags instead.

arn String
Amazon Resource Name (ARN) of the framework.

  • control_sets[*].id - Unique identifier for the framework control set.
complianceType String
Compliance type that the new custom framework supports, such as CIS or HIPAA.
controlSets List<Property Map>

Configuration block(s) for the control sets that are associated with the framework. See control_sets Block below for details.

The following arguments are optional:

description String
Description of the framework.
frameworkType String
Framework type, such as a custom framework or a standard framework.
name String
Name of the framework.
tags Map<String>
A map of tags to assign to the framework. 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>

Deprecated: Please use tags instead.

Supporting Types

FrameworkControlSet
, FrameworkControlSetArgs

Name This property is required. string
Name of the control set.
Controls List<FrameworkControlSetControl>
Configuration block(s) for the controls within the control set. See controls Block below for details.
Id string
Unique identifier for the framework.
Name This property is required. string
Name of the control set.
Controls []FrameworkControlSetControl
Configuration block(s) for the controls within the control set. See controls Block below for details.
Id string
Unique identifier for the framework.
name This property is required. String
Name of the control set.
controls List<FrameworkControlSetControl>
Configuration block(s) for the controls within the control set. See controls Block below for details.
id String
Unique identifier for the framework.
name This property is required. string
Name of the control set.
controls FrameworkControlSetControl[]
Configuration block(s) for the controls within the control set. See controls Block below for details.
id string
Unique identifier for the framework.
name This property is required. str
Name of the control set.
controls Sequence[FrameworkControlSetControl]
Configuration block(s) for the controls within the control set. See controls Block below for details.
id str
Unique identifier for the framework.
name This property is required. String
Name of the control set.
controls List<Property Map>
Configuration block(s) for the controls within the control set. See controls Block below for details.
id String
Unique identifier for the framework.

FrameworkControlSetControl
, FrameworkControlSetControlArgs

Id This property is required. string
Unique identifier of the control.
Id This property is required. string
Unique identifier of the control.
id This property is required. String
Unique identifier of the control.
id This property is required. string
Unique identifier of the control.
id This property is required. str
Unique identifier of the control.
id This property is required. String
Unique identifier of the control.

Import

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

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

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.
AWS v6.75.0 published on Wednesday, Apr 2, 2025 by Pulumi
pulumi/pulumi-aws