Package com.pulumi.aws.cfg

Class Recorder

  • public class Recorder
extends com.pulumi.resources.CustomResource
    Provides an AWS Config Configuration Recorder. Please note that this resource **does not start** the created recorder automatically. > **Note:** _Starting_ the Configuration Recorder requires a delivery channel (while delivery channel creation requires Configuration Recorder). This is why `aws.cfg.RecorderStatus` is a separate resource. ## Example Usage ### Basic Usage 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.iam.IamFunctions;
 import com.pulumi.aws.iam.inputs.GetPolicyDocumentArgs;
 import com.pulumi.aws.iam.inputs.GetPolicyDocumentStatementArgs;
 import com.pulumi.aws.iam.inputs.GetPolicyDocumentStatementPrincipalArgs;
 import com.pulumi.aws.iam.Role;
 import com.pulumi.aws.iam.RoleArgs;
 import com.pulumi.aws.cfg.Recorder;
 import com.pulumi.aws.cfg.RecorderArgs;
 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 assumeRole = IamFunctions.getPolicyDocument(GetPolicyDocumentArgs.builder()
             .statements(GetPolicyDocumentStatementArgs.builder()
                 .principals(GetPolicyDocumentStatementPrincipalArgs.builder()
                     .type("Service")
                     .identifiers("config.amazonaws.com")
                     .build())
                 .effect("Allow")
                 .actions("sts:AssumeRole")
                 .build())
             .build());
 
         var r = new Role("r", RoleArgs.builder()
             .name("awsconfig-example")
             .assumeRolePolicy(assumeRole.json())
             .build());
 
         var foo = new Recorder("foo", RecorderArgs.builder()
             .name("example")
             .roleArn(r.arn())
             .build());
 
     }
 }
    ### Exclude Resources Types Usage 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.cfg.Recorder;
 import com.pulumi.aws.cfg.RecorderArgs;
 import com.pulumi.aws.cfg.inputs.RecorderRecordingGroupArgs;
 import com.pulumi.aws.cfg.inputs.RecorderRecordingGroupExclusionByResourceTypeArgs;
 import com.pulumi.aws.cfg.inputs.RecorderRecordingGroupRecordingStrategyArgs;
 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 foo = new Recorder("foo", RecorderArgs.builder()
             .recordingGroup(RecorderRecordingGroupArgs.builder()
                 .exclusionByResourceTypes(RecorderRecordingGroupExclusionByResourceTypeArgs.builder()
                     .resourceTypes("AWS::EC2::Instance")
                     .build())
                 .recordingStrategies(RecorderRecordingGroupRecordingStrategyArgs.builder()
                     .useOnly("EXCLUSION_BY_RESOURCE_TYPES")
                     .build())
                 .allSupported(false)
                 .build())
             .name("example")
             .roleArn(r.arn())
             .build());
 
     }
 }
    ### Periodic Recording 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.cfg.Recorder;
 import com.pulumi.aws.cfg.RecorderArgs;
 import com.pulumi.aws.cfg.inputs.RecorderRecordingGroupArgs;
 import com.pulumi.aws.cfg.inputs.RecorderRecordingModeArgs;
 import com.pulumi.aws.cfg.inputs.RecorderRecordingModeRecordingModeOverrideArgs;
 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 foo = new Recorder("foo", RecorderArgs.builder()
             .recordingGroup(RecorderRecordingGroupArgs.builder()
                 .allSupported(false)
                 .includeGlobalResourceTypes(false)
                 .resourceTypes(                
                     "AWS::EC2::Instance",
                     "AWS::EC2::NetworkInterface")
                 .build())
             .recordingMode(RecorderRecordingModeArgs.builder()
                 .recordingModeOverride(RecorderRecordingModeRecordingModeOverrideArgs.builder()
                     .description("Only record EC2 network interfaces daily")
                     .resourceTypes("AWS::EC2::NetworkInterface")
                     .recordingFrequency("DAILY")
                     .build())
                 .recordingFrequency("CONTINUOUS")
                 .build())
             .name("example")
             .roleArn(r.arn())
             .build());
 
     }
 }
    ## Import ### Identity Schema #### Required * `name` (String) Name of the configuration recorder. #### Optional * `accountId` (String) AWS Account where this resource is managed. * `region` (String) Region where this resource is managed. Using `pulumi import`, import Configuration Recorders using the `name`. For example: ```sh $ pulumi import aws:cfg/recorder:Recorder example example ```

    • 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
      Recorder​(java.lang.String name)  
      Recorder​(java.lang.String name, RecorderArgs args)  
      Recorder​(java.lang.String name, RecorderArgs args, com.pulumi.resources.CustomResourceOptions options)  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static Recorder get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, RecorderState 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<RecorderRecordingGroup> recordingGroup()  
      com.pulumi.core.Output<RecorderRecordingMode> recordingMode()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.lang.String> roleArn()  

      • 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

      • Recorder

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

      • Recorder

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

      • Recorder

        public Recorder​(java.lang.String name,
                RecorderArgs 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

      • name

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        The name of the configuration recorder. Defaults to `default`. Changing it recreates the resource.

      • recordingGroup

        public com.pulumi.core.Output<RecorderRecordingGroup> recordingGroup()
        Returns:
        Recording group - see below.

      • recordingMode

        public com.pulumi.core.Output<RecorderRecordingMode> recordingMode()
        Returns:
        Recording mode - see below.

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

      • roleArn

        public com.pulumi.core.Output<java.lang.String> roleArn()
        Returns:
        ARN of the IAM role. Used to make read or write requests to the delivery channel and to describe the AWS resources associated with the account. See [AWS Docs](http://docs.aws.amazon.com/config/latest/developerguide/iamrole-permissions.html) for more details.

      • get

        public static Recorder get​(java.lang.String name,
                           com.pulumi.core.Output<java.lang.String> id,
                           @Nullable
                           RecorderState 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.