Package software.amazon.awscdk.services.config

Interface CfnConfigurationRecorderProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnConfigurationRecorderProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:48.560Z")
@Stability(Stable)
public interface CfnConfigurationRecorderProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnConfigurationRecorder.

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.*;
 CfnConfigurationRecorderProps cfnConfigurationRecorderProps = CfnConfigurationRecorderProps.builder()
         .roleArn("roleArn")
         // the properties below are optional
         .name("name")
         .recordingGroup(RecordingGroupProperty.builder()
                 .allSupported(false)
                 .includeGlobalResourceTypes(false)
                 .resourceTypes(List.of("resourceTypes"))
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnConfigurationRecorderProps.Builder	A builder for CfnConfigurationRecorderProps
static final class	CfnConfigurationRecorderProps.Jsii$Proxy	An implementation for CfnConfigurationRecorderProps

Method Summary

Modifier and Type	Method	Description
static CfnConfigurationRecorderProps.Builder	builder()
default String	getName()	A name for the configuration recorder.
default Object	getRecordingGroup()	Indicates whether to record configurations for all supported resources or for a list of resource types.
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.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getRoleArn

@Stability(Stable)
@NotNull
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.

getName

@Stability(Stable)
@Nullable
default 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.

getRecordingGroup

@Stability(Stable)
@Nullable
default 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 .

builder

@Stability(Stable)
static CfnConfigurationRecorderProps.Builder builder()

Returns:

a CfnConfigurationRecorderProps.Builder of CfnConfigurationRecorderProps