1. Packages
  2. AWS
  3. API Docs
  4. auditmanager
  5. getFramework
AWS v7.5.0 published on Wednesday, Aug 20, 2025 by Pulumi

aws.auditmanager.getFramework

Explore with Pulumi AI

aws logo
AWS v7.5.0 published on Wednesday, Aug 20, 2025 by Pulumi

    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.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) {
            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
    

    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: Optional[pulumi.Input[str]] = None,
                      name: Optional[pulumi.Input[str]] = None,
                      region: Optional[pulumi.Input[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

    The following arguments are supported:

    FrameworkType string
    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
    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
    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
    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
    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
    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
    ComplianceType string
    ControlSets List<GetFrameworkControlSet>
    Description string
    FrameworkType string
    Id string
    Name string
    Region string
    Tags Dictionary<string, string>
    Arn string
    ComplianceType string
    ControlSets []GetFrameworkControlSet
    Description string
    FrameworkType string
    Id string
    Name string
    Region string
    Tags map[string]string
    arn String
    complianceType String
    controlSets List<GetFrameworkControlSet>
    description String
    frameworkType String
    id String
    name String
    region String
    tags Map<String,String>
    arn string
    complianceType string
    controlSets GetFrameworkControlSet[]
    description string
    frameworkType string
    id string
    name string
    region string
    tags {[key: string]: string}
    arn String
    complianceType String
    controlSets List<Property Map>
    description String
    frameworkType String
    id String
    name String
    region String
    tags Map<String>

    Supporting Types

    GetFrameworkControlSet

    Controls List<GetFrameworkControlSetControl>
    Id string
    Name string
    Name of the framework.
    Controls []GetFrameworkControlSetControl
    Id string
    Name string
    Name of the framework.
    controls List<GetFrameworkControlSetControl>
    id String
    name String
    Name of the framework.
    controls GetFrameworkControlSetControl[]
    id string
    name string
    Name of the framework.
    controls List<Property Map>
    id String
    name String
    Name of the framework.

    GetFrameworkControlSetControl

    Id string
    Id string
    id String
    id string
    id str
    id String

    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
    AWS v7.5.0 published on Wednesday, Aug 20, 2025 by Pulumi