Package software.amazon.awscdk.services.config

Class CfnConfigurationRecorder

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.config.CfnConfigurationRecorder
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:48.557Z") @Stability(Stable) public class CfnConfigurationRecorder extends CfnResource implements IInspectable
A CloudFormation AWS::Config::ConfigurationRecorder.

The AWS::Config::ConfigurationRecorder resource describes the AWS resource types for which AWS Config records configuration changes. The configuration recorder stores the configurations of the supported resources in your account as configuration items.

To enable AWS Config , you must create a configuration recorder and a delivery channel. AWS Config uses the delivery channel to deliver the configuration changes to your Amazon S3 bucket or Amazon SNS topic. For more information, see AWS::Config::DeliveryChannel .

AWS CloudFormation starts the recorder as soon as the delivery channel is available.

To stop the recorder and delete it, delete the configuration recorder from your stack. To stop the recorder without deleting it, call the StopConfigurationRecorder action of the AWS Config API directly.

For more information, see Configuration Recorder in the AWS Config Developer Guide.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.config.*;
 CfnConfigurationRecorder cfnConfigurationRecorder = CfnConfigurationRecorder.Builder.create(this, "MyCfnConfigurationRecorder")
         .roleArn("roleArn")
         // the properties below are optional
         .name("name")
         .recordingGroup(RecordingGroupProperty.builder()
                 .allSupported(false)
                 .includeGlobalResourceTypes(false)
                 .resourceTypes(List.of("resourceTypes"))
                 .build())
         .build();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnConfigurationRecorder

      protected CfnConfigurationRecorder(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnConfigurationRecorder

      protected CfnConfigurationRecorder(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnConfigurationRecorder

      @Stability(Stable) public CfnConfigurationRecorder(@NotNull Construct scope, @NotNull String id, @NotNull CfnConfigurationRecorderProps props)
      Create a new AWS::Config::ConfigurationRecorder.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getRoleArn

      @Stability(Stable) @NotNull public String getRoleArn()
      The Amazon Resource Name (ARN) of the IAM (IAM) role that is used to make read or write requests to the delivery channel that you specify and to get configuration details for supported AWS resources.

      For more information, see Permissions for the IAM Role Assigned to AWS Config in the AWS Config Developer Guide.

    • setRoleArn

      @Stability(Stable) public void setRoleArn(@NotNull String value)
      The Amazon Resource Name (ARN) of the IAM (IAM) role that is used to make read or write requests to the delivery channel that you specify and to get configuration details for supported AWS resources.

      For more information, see Permissions for the IAM Role Assigned to AWS Config in the AWS Config Developer Guide.

    • getName

      @Stability(Stable) @Nullable public String getName()
      A name for the configuration recorder.

      If you don't specify a name, AWS CloudFormation CloudFormation generates a unique physical ID and uses that ID for the configuration recorder name. For more information, see Name Type .

      After you create a configuration recorder, you cannot rename it. If you don't want a name that AWS CloudFormation generates, specify a value for this property.

      Updates are not supported.

    • setName

      @Stability(Stable) public void setName(@Nullable String value)
      A name for the configuration recorder.

      If you don't specify a name, AWS CloudFormation CloudFormation generates a unique physical ID and uses that ID for the configuration recorder name. For more information, see Name Type .

      After you create a configuration recorder, you cannot rename it. If you don't want a name that AWS CloudFormation generates, specify a value for this property.

      Updates are not supported.

    • getRecordingGroup

      @Stability(Stable) @Nullable public Object getRecordingGroup()
      Indicates whether to record configurations for all supported resources or for a list of resource types.

      The resource types that you list must be supported by AWS Config .

    • setRecordingGroup

      @Stability(Stable) public void setRecordingGroup(@Nullable IResolvable value)
      Indicates whether to record configurations for all supported resources or for a list of resource types.

      The resource types that you list must be supported by AWS Config .

    • setRecordingGroup

      @Stability(Stable) public void setRecordingGroup(@Nullable CfnConfigurationRecorder.RecordingGroupProperty value)
      Indicates whether to record configurations for all supported resources or for a list of resource types.

      The resource types that you list must be supported by AWS Config .