Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. AWS
  4. API Docs
  5. auditmanager
  6. getFramework
Viewing docs for AWS v7.31.0
published on Tuesday, May 26, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws

aws.auditmanager.getFramework

aws logo
Viewing docs for AWS v7.31.0
published on Tuesday, May 26, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws

    Data source for managing an AWS Audit Manager Framework.

    Example Usage

    Basic Usage

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

const example = aws.auditmanager.getFramework({
    name: "Essential Eight",
    frameworkType: "Standard",
});

    import pulumi
import pulumi_aws as aws

example = aws.auditmanager.get_framework(name="Essential Eight",
    framework_type="Standard")

    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.LookupFramework(ctx, &auditmanager.LookupFrameworkArgs{
			Name:          "Essential Eight",
			FrameworkType: "Standard",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = Aws.Auditmanager.GetFramework.Invoke(new()
    {
        Name = "Essential Eight",
        FrameworkType = "Standard",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.auditmanager.AuditmanagerFunctions;
import com.pulumi.aws.auditmanager.inputs.GetFrameworkArgs;
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) {
        final var example = AuditmanagerFunctions.getFramework(GetFrameworkArgs.builder()
            .name("Essential Eight")
            .frameworkType("Standard")
            .build());

    }
}

    variables:
  example:
    fn::invoke:
      function: aws:auditmanager:getFramework
      arguments:
        name: Essential Eight
        frameworkType: Standard

    pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

data "aws_auditmanager_getframework" "example" {
  name           = "Essential Eight"
  framework_type = "Standard"
}

    Using getFramework

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getFramework(args: GetFrameworkArgs, opts?: InvokeOptions): Promise<GetFrameworkResult>
function getFrameworkOutput(args: GetFrameworkOutputArgs, opts?: InvokeOptions): Output<GetFrameworkResult>
    def get_framework(framework_type: Optional[str] = None,
                  name: Optional[str] = None,
                  region: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetFrameworkResult
def get_framework_output(framework_type: pulumi.Input[Optional[str]] = None,
                  name: pulumi.Input[Optional[str]] = None,
                  region: pulumi.Input[Optional[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetFrameworkResult]
    func LookupFramework(ctx *Context, args *LookupFrameworkArgs, opts ...InvokeOption) (*LookupFrameworkResult, error)
func LookupFrameworkOutput(ctx *Context, args *LookupFrameworkOutputArgs, opts ...InvokeOption) LookupFrameworkResultOutput

    > Note: This function is named LookupFramework in the Go SDK.

    public static class GetFramework 
{
    public static Task<GetFrameworkResult> InvokeAsync(GetFrameworkArgs args, InvokeOptions? opts = null)
    public static Output<GetFrameworkResult> Invoke(GetFrameworkInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetFrameworkResult> getFramework(GetFrameworkArgs args, InvokeOptions options)
public static Output<GetFrameworkResult> getFramework(GetFrameworkArgs args, InvokeOptions options)

    fn::invoke:
  function: aws:auditmanager/getFramework:getFramework
  arguments:
    # arguments dictionary
    data "aws_auditmanager_getframework" "name" {
    # arguments
}

    The following arguments are supported:

    FrameworkType string
    Type of framework. Valid values are Custom and Standard.
    Name string
    Name of the framework.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    FrameworkType string
    Type of framework. Valid values are Custom and Standard.
    Name string
    Name of the framework.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    framework_type string
    Type of framework. Valid values are Custom and Standard.
    name string
    Name of the framework.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    frameworkType String
    Type of framework. Valid values are Custom and Standard.
    name String
    Name of the framework.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    frameworkType string
    Type of framework. Valid values are Custom and Standard.
    name string
    Name of the framework.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    framework_type str
    Type of framework. Valid values are Custom and Standard.
    name str
    Name of the framework.
    region str
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    frameworkType String
    Type of framework. Valid values are Custom and Standard.
    name String
    Name of the framework.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.

    getFramework Result

    The following output properties are available:

    Arn string
    ARN of the framework.
    ComplianceType string
    Compliance type that the framework supports.
    ControlSets List<GetFrameworkControlSet>
    Control sets associated with the framework.
    Description string
    Description of the framework.
    FrameworkType string
    Id string
    Unique identifier for the framework.
    Name string
    Region string
    Tags Dictionary<string, string>
    Map of tags assigned to the framework.
    Arn string
    ARN of the framework.
    ComplianceType string
    Compliance type that the framework supports.
    ControlSets []GetFrameworkControlSet
    Control sets associated with the framework.
    Description string
    Description of the framework.
    FrameworkType string
    Id string
    Unique identifier for the framework.
    Name string
    Region string
    Tags map[string]string
    Map of tags assigned to the framework.
    arn string
    ARN of the framework.
    compliance_type string
    Compliance type that the framework supports.
    control_sets list(object)
    Control sets associated with the framework.
    description string
    Description of the framework.
    framework_type string
    id string
    Unique identifier for the framework.
    name string
    region string
    tags map(string)
    Map of tags assigned to the framework.
    arn String
    ARN of the framework.
    complianceType String
    Compliance type that the framework supports.
    controlSets List<GetFrameworkControlSet>
    Control sets associated with the framework.
    description String
    Description of the framework.
    frameworkType String
    id String
    Unique identifier for the framework.
    name String
    region String
    tags Map<String,String>
    Map of tags assigned to the framework.
    arn string
    ARN of the framework.
    complianceType string
    Compliance type that the framework supports.
    controlSets GetFrameworkControlSet[]
    Control sets associated with the framework.
    description string
    Description of the framework.
    frameworkType string
    id string
    Unique identifier for the framework.
    name string
    region string
    tags {[key: string]: string}
    Map of tags assigned to the framework.
    arn str
    ARN of the framework.
    compliance_type str
    Compliance type that the framework supports.
    control_sets Sequence[GetFrameworkControlSet]
    Control sets associated with the framework.
    description str
    Description of the framework.
    framework_type str
    id str
    Unique identifier for the framework.
    name str
    region str
    tags Mapping[str, str]
    Map of tags assigned to the framework.
    arn String
    ARN of the framework.
    complianceType String
    Compliance type that the framework supports.
    controlSets List<Property Map>
    Control sets associated with the framework.
    description String
    Description of the framework.
    frameworkType String
    id String
    Unique identifier for the framework.
    name String
    region String
    tags Map<String>
    Map of tags assigned to the framework.

    Supporting Types

    GetFrameworkControlSet

    Controls List<GetFrameworkControlSetControl>
    Id string
    Unique identifier for the framework.
    Name string
    Name of the framework.
    Controls []GetFrameworkControlSetControl
    Id string
    Unique identifier for the framework.
    Name string
    Name of the framework.
    controls list(object)
    id string
    Unique identifier for the framework.
    name string
    Name of the framework.
    controls List<GetFrameworkControlSetControl>
    id String
    Unique identifier for the framework.
    name String
    Name of the framework.
    controls GetFrameworkControlSetControl[]
    id string
    Unique identifier for the framework.
    name string
    Name of the framework.
    controls Sequence[GetFrameworkControlSetControl]
    id str
    Unique identifier for the framework.
    name str
    Name of the framework.
    controls List<Property Map>
    id String
    Unique identifier for the framework.
    name String
    Name of the framework.

    GetFrameworkControlSetControl

    Id string
    Unique identifier for the framework.
    Id string
    Unique identifier for the framework.
    id string
    Unique identifier for the framework.
    id String
    Unique identifier for the framework.
    id string
    Unique identifier for the framework.
    id str
    Unique identifier for the framework.
    id String
    Unique identifier for the framework.

    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
    Viewing docs for AWS v7.31.0
    published on Tuesday, May 26, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-aws

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial