Package com.pulumi.aws.auditmanager

Class Assessment

  • public class Assessment
extends com.pulumi.resources.CustomResource
    Resource for managing an AWS Audit Manager Assessment. ## 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.Assessment;
 import com.pulumi.aws.auditmanager.AssessmentArgs;
 import com.pulumi.aws.auditmanager.inputs.AssessmentAssessmentReportsDestinationArgs;
 import com.pulumi.aws.auditmanager.inputs.AssessmentScopeArgs;
 import com.pulumi.aws.auditmanager.inputs.AssessmentScopeAwsAccountArgs;
 import com.pulumi.aws.auditmanager.inputs.AssessmentScopeAwsServiceArgs;
 import com.pulumi.aws.auditmanager.inputs.AssessmentRoleArgs;
 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 Assessment("test", AssessmentArgs.builder()
             .assessmentReportsDestination(AssessmentAssessmentReportsDestinationArgs.builder()
                 .destination(String.format("s3://%s", testAwsS3Bucket.id()))
                 .destinationType("S3")
                 .build())
             .scope(AssessmentScopeArgs.builder()
                 .awsAccounts(AssessmentScopeAwsAccountArgs.builder()
                     .id(current.accountId())
                     .build())
                 .awsServices(AssessmentScopeAwsServiceArgs.builder()
                     .serviceName("S3")
                     .build())
                 .build())
             .roles(AssessmentRoleArgs.builder()
                 .roleArn(testAwsIamRole.arn())
                 .roleType("PROCESS_OWNER")
                 .build())
             .name("example")
             .frameworkId(testAwsAuditmanagerFramework.id())
             .build());
 
     }
 }
    ## Import ### Identity Schema #### Required * `id` (String) Unique identifier for the assessment. #### Optional * `accountId` (String) AWS Account where this resource is managed. * `region` (String) Region where this resource is managed. Using `pulumi import`, import Audit Manager Assessments using the assessment `id`. For example: ```sh $ pulumi import aws:auditmanager/assessment:Assessment 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

    • 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<AssessmentAssessmentReportsDestination>> assessmentReportsDestination()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()  
      com.pulumi.core.Output<java.lang.String> frameworkId()  
      static Assessment get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, AssessmentState 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.List<AssessmentRole>> roles()  
      com.pulumi.core.Output<java.util.List<AssessmentRolesAll>> rolesAlls()  
      com.pulumi.core.Output<java.util.Optional<AssessmentScope>> scope()  
      com.pulumi.core.Output<java.lang.String> status()  
      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

      • Assessment

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

      • Assessment

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

      • Assessment

        public Assessment​(java.lang.String name,
                  AssessmentArgs 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 assessment.

      • assessmentReportsDestination

        public com.pulumi.core.Output<java.util.Optional<AssessmentAssessmentReportsDestination>> assessmentReportsDestination()
        Returns:
        Assessment report storage destination configuration. See `assessmentReportsDestination` below.

      • description

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

      • frameworkId

        public com.pulumi.core.Output<java.lang.String> frameworkId()
        Returns:
        Unique identifier of the framework the assessment will be created from.

      • name

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

      • 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.

      • roles

        public com.pulumi.core.Output<java.util.List<AssessmentRole>> roles()
        Returns:
        List of roles for the assessment. See `roles` below.

      • rolesAlls

        public com.pulumi.core.Output<java.util.List<AssessmentRolesAll>> rolesAlls()
        Returns:
        Complete list of all roles with access to the assessment. This includes both roles explicitly configured via the `roles` block, and any roles which have access to all Audit Manager assessments by default.

      • scope

        public com.pulumi.core.Output<java.util.Optional<AssessmentScope>> scope()
        Returns:
        Amazon Web Services accounts and services that are in scope for the assessment. See `scope` below. The following arguments are optional:

      • status

        public com.pulumi.core.Output<java.lang.String> status()
        Returns:
        Status of the assessment. Valid values are `ACTIVE` and `INACTIVE`.

      • 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 assessment. 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 Assessment get​(java.lang.String name,
                             com.pulumi.core.Output<java.lang.String> id,
                             @Nullable
                             AssessmentState 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.