software.amazon.awscdk.services.config

Interface CfnConfigurationRecorderProps

All Known Implementing Classes:

CfnConfigurationRecorderProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-28T21:34:29.993Z")
public interface CfnConfigurationRecorderProps

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 and Description
static class	CfnConfigurationRecorderProps.Builder A builder for CfnConfigurationRecorderProps
static class	CfnConfigurationRecorderProps.Jsii$Proxy An implementation for CfnConfigurationRecorderProps

Method Summary

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

Method Detail

getRoleArn

java.lang.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

default java.lang.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

default java.lang.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

static CfnConfigurationRecorderProps.Builder builder()

Returns:

a CfnConfigurationRecorderProps.Builder of CfnConfigurationRecorderProps