Class Framework


  • public class Framework
    extends com.pulumi.resources.CustomResource
    Resource for managing an AWS Audit Manager Framework. ## Example Usage ### Basic Usage
     
     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());
     
         }
     }
     
     
    ## 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: ```sh $ pulumi import aws:auditmanager/framework:Framework example abc123-de45 ```
    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal
      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal
    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote
    • Constructor Summary

      Constructors 
      Constructor Description
      Framework​(java.lang.String name)  
      Framework​(java.lang.String name, FrameworkArgs args)  
      Framework​(java.lang.String name, FrameworkArgs args, com.pulumi.resources.CustomResourceOptions options)  
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> arn()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> complianceType()  
      com.pulumi.core.Output<java.util.Optional<java.util.List<FrameworkControlSet>>> controlSets()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()  
      com.pulumi.core.Output<java.lang.String> frameworkType()  
      static Framework get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, FrameworkState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.lang.String> name()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()  
      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture
      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • Framework

        public Framework​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.
      • Framework

        public Framework​(java.lang.String name,
                         @Nullable
                         FrameworkArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
      • Framework

        public Framework​(java.lang.String name,
                         @Nullable
                         FrameworkArgs args,
                         @Nullable
                         com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.
    • Method Detail

      • arn

        public com.pulumi.core.Output<java.lang.String> arn()
        Returns:
        ARN of the framework. * `control_sets[*].id` - Unique identifier for the framework control set.
      • complianceType

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> complianceType()
        Returns:
        Compliance type that the new custom framework supports, such as `CIS` or `HIPAA`.
      • controlSets

        public com.pulumi.core.Output<java.util.Optional<java.util.List<FrameworkControlSet>>> controlSets()
        Returns:
        Configuration block(s) for the control sets that are associated with the framework. See `controlSets` Block below for details. The following arguments are optional:
      • description

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()
        Returns:
        Description of the framework.
      • frameworkType

        public com.pulumi.core.Output<java.lang.String> frameworkType()
        Returns:
        Framework type, such as a custom framework or a standard framework.
      • name

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        Name of the framework.
      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        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.
      • tagsAll

        public com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()
      • get

        public static Framework get​(java.lang.String name,
                                    com.pulumi.core.Output<java.lang.String> id,
                                    @Nullable
                                    FrameworkState state,
                                    @Nullable
                                    com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.