[ aws . configservice ]

associate-resource-types

Description

Adds all resource types specified in the ResourceTypes list to the RecordingGroup of specified configuration recorder and includes those resource types when recording.

For this operation, the specified configuration recorder must use a RecordingStrategy that is either INCLUSION_BY_RESOURCE_TYPES or EXCLUSION_BY_RESOURCE_TYPES .

See also: AWS API Documentation

Synopsis

  associate-resource-types
--configuration-recorder-arn <value>
--resource-types <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--configuration-recorder-arn (string)

The Amazon Resource Name (ARN) of the specified configuration recorder.

--resource-types (list)

The list of resource types you want to add to the recording group of the specified configuration recorder.

(string)

Syntax:

"string" "string" ...

Where valid values are:
  AWS::EC2::CustomerGateway
  AWS::EC2::EIP
  AWS::EC2::Host
  AWS::EC2::Instance
  AWS::EC2::InternetGateway
  AWS::EC2::NetworkAcl
  AWS::EC2::NetworkInterface
  AWS::EC2::RouteTable
  AWS::EC2::SecurityGroup
  AWS::EC2::Subnet
  AWS::CloudTrail::Trail
  AWS::EC2::Volume
  AWS::EC2::VPC
  AWS::EC2::VPNConnection
  AWS::EC2::VPNGateway
  AWS::EC2::RegisteredHAInstance
  AWS::EC2::NatGateway
  AWS::EC2::EgressOnlyInternetGateway
  AWS::EC2::VPCEndpoint
  AWS::EC2::VPCEndpointService
  AWS::EC2::FlowLog
  AWS::EC2::VPCPeeringConnection
  AWS::Elasticsearch::Domain
  AWS::IAM::Group
  AWS::IAM::Policy
  AWS::IAM::Role
  AWS::IAM::User
  AWS::ElasticLoadBalancingV2::LoadBalancer
  AWS::ACM::Certificate
  AWS::RDS::DBInstance
  AWS::RDS::DBSubnetGroup
  AWS::RDS::DBSecurityGroup
  AWS::RDS::DBSnapshot
  AWS::RDS::DBCluster
  AWS::RDS::DBClusterSnapshot
  AWS::RDS::EventSubscription
  AWS::S3::Bucket
  AWS::S3::AccountPublicAccessBlock
  AWS::Redshift::Cluster
  AWS::Redshift::ClusterSnapshot
  AWS::Redshift::ClusterParameterGroup
  AWS::Redshift::ClusterSecurityGroup
  AWS::Redshift::ClusterSubnetGroup
  AWS::Redshift::EventSubscription
  AWS::SSM::ManagedInstanceInventory
  AWS::CloudWatch::Alarm
  AWS::CloudFormation::Stack
  AWS::ElasticLoadBalancing::LoadBalancer
  AWS::AutoScaling::AutoScalingGroup
  AWS::AutoScaling::LaunchConfiguration
  AWS::AutoScaling::ScalingPolicy
  AWS::AutoScaling::ScheduledAction
  AWS::DynamoDB::Table
  AWS::CodeBuild::Project
  AWS::WAF::RateBasedRule
  AWS::WAF::Rule
  AWS::WAF::RuleGroup
  AWS::WAF::WebACL
  AWS::WAFRegional::RateBasedRule
  AWS::WAFRegional::Rule
  AWS::WAFRegional::RuleGroup
  AWS::WAFRegional::WebACL
  AWS::CloudFront::Distribution
  AWS::CloudFront::StreamingDistribution
  AWS::Lambda::Function
  AWS::NetworkFirewall::Firewall
  AWS::NetworkFirewall::FirewallPolicy
  AWS::NetworkFirewall::RuleGroup
  AWS::ElasticBeanstalk::Application
  AWS::ElasticBeanstalk::ApplicationVersion
  AWS::ElasticBeanstalk::Environment
  AWS::WAFv2::WebACL
  AWS::WAFv2::RuleGroup
  AWS::WAFv2::IPSet
  AWS::WAFv2::RegexPatternSet
  AWS::WAFv2::ManagedRuleSet
  AWS::XRay::EncryptionConfig
  AWS::SSM::AssociationCompliance
  AWS::SSM::PatchCompliance
  AWS::Shield::Protection
  AWS::ShieldRegional::Protection
  AWS::Config::ConformancePackCompliance
  AWS::Config::ResourceCompliance
  AWS::ApiGateway::Stage
  AWS::ApiGateway::RestApi
  AWS::ApiGatewayV2::Stage
  AWS::ApiGatewayV2::Api
  AWS::CodePipeline::Pipeline
  AWS::ServiceCatalog::CloudFormationProvisionedProduct
  AWS::ServiceCatalog::CloudFormationProduct
  AWS::ServiceCatalog::Portfolio
  AWS::SQS::Queue
  AWS::KMS::Key
  AWS::QLDB::Ledger
  AWS::SecretsManager::Secret
  AWS::SNS::Topic
  AWS::SSM::FileData
  AWS::Backup::BackupPlan
  AWS::Backup::BackupSelection
  AWS::Backup::BackupVault
  AWS::Backup::RecoveryPoint
  AWS::ECR::Repository
  AWS::ECS::Cluster
  AWS::ECS::Service
  AWS::ECS::TaskDefinition
  AWS::EFS::AccessPoint
  AWS::EFS::FileSystem
  AWS::EKS::Cluster
  AWS::OpenSearch::Domain
  AWS::EC2::TransitGateway
  AWS::Kinesis::Stream
  AWS::Kinesis::StreamConsumer
  AWS::CodeDeploy::Application
  AWS::CodeDeploy::DeploymentConfig
  AWS::CodeDeploy::DeploymentGroup
  AWS::EC2::LaunchTemplate
  AWS::ECR::PublicRepository
  AWS::GuardDuty::Detector
  AWS::EMR::SecurityConfiguration
  AWS::SageMaker::CodeRepository
  AWS::Route53Resolver::ResolverEndpoint
  AWS::Route53Resolver::ResolverRule
  AWS::Route53Resolver::ResolverRuleAssociation
  AWS::DMS::ReplicationSubnetGroup
  AWS::DMS::EventSubscription
  AWS::MSK::Cluster
  AWS::StepFunctions::Activity
  AWS::WorkSpaces::Workspace
  AWS::WorkSpaces::ConnectionAlias
  AWS::SageMaker::Model
  AWS::ElasticLoadBalancingV2::Listener
  AWS::StepFunctions::StateMachine
  AWS::Batch::JobQueue
  AWS::Batch::ComputeEnvironment
  AWS::AccessAnalyzer::Analyzer
  AWS::Athena::WorkGroup
  AWS::Athena::DataCatalog
  AWS::Detective::Graph
  AWS::GlobalAccelerator::Accelerator
  AWS::GlobalAccelerator::EndpointGroup
  AWS::GlobalAccelerator::Listener
  AWS::EC2::TransitGatewayAttachment
  AWS::EC2::TransitGatewayRouteTable
  AWS::DMS::Certificate
  AWS::AppConfig::Application
  AWS::AppSync::GraphQLApi
  AWS::DataSync::LocationSMB
  AWS::DataSync::LocationFSxLustre
  AWS::DataSync::LocationS3
  AWS::DataSync::LocationEFS
  AWS::DataSync::Task
  AWS::DataSync::LocationNFS
  AWS::EC2::NetworkInsightsAccessScopeAnalysis
  AWS::EKS::FargateProfile
  AWS::Glue::Job
  AWS::GuardDuty::ThreatIntelSet
  AWS::GuardDuty::IPSet
  AWS::SageMaker::Workteam
  AWS::SageMaker::NotebookInstanceLifecycleConfig
  AWS::ServiceDiscovery::Service
  AWS::ServiceDiscovery::PublicDnsNamespace
  AWS::SES::ContactList
  AWS::SES::ConfigurationSet
  AWS::Route53::HostedZone
  AWS::IoTEvents::Input
  AWS::IoTEvents::DetectorModel
  AWS::IoTEvents::AlarmModel
  AWS::ServiceDiscovery::HttpNamespace
  AWS::Events::EventBus
  AWS::ImageBuilder::ContainerRecipe
  AWS::ImageBuilder::DistributionConfiguration
  AWS::ImageBuilder::InfrastructureConfiguration
  AWS::DataSync::LocationObjectStorage
  AWS::DataSync::LocationHDFS
  AWS::Glue::Classifier
  AWS::Route53RecoveryReadiness::Cell
  AWS::Route53RecoveryReadiness::ReadinessCheck
  AWS::ECR::RegistryPolicy
  AWS::Backup::ReportPlan
  AWS::Lightsail::Certificate
  AWS::RUM::AppMonitor
  AWS::Events::Endpoint
  AWS::SES::ReceiptRuleSet
  AWS::Events::Archive
  AWS::Events::ApiDestination
  AWS::Lightsail::Disk
  AWS::FIS::ExperimentTemplate
  AWS::DataSync::LocationFSxWindows
  AWS::SES::ReceiptFilter
  AWS::GuardDuty::Filter
  AWS::SES::Template
  AWS::AmazonMQ::Broker
  AWS::AppConfig::Environment
  AWS::AppConfig::ConfigurationProfile
  AWS::Cloud9::EnvironmentEC2
  AWS::EventSchemas::Registry
  AWS::EventSchemas::RegistryPolicy
  AWS::EventSchemas::Discoverer
  AWS::FraudDetector::Label
  AWS::FraudDetector::EntityType
  AWS::FraudDetector::Variable
  AWS::FraudDetector::Outcome
  AWS::IoT::Authorizer
  AWS::IoT::SecurityProfile
  AWS::IoT::RoleAlias
  AWS::IoT::Dimension
  AWS::IoTAnalytics::Datastore
  AWS::Lightsail::Bucket
  AWS::Lightsail::StaticIp
  AWS::MediaPackage::PackagingGroup
  AWS::Route53RecoveryReadiness::RecoveryGroup
  AWS::ResilienceHub::ResiliencyPolicy
  AWS::Transfer::Workflow
  AWS::EKS::IdentityProviderConfig
  AWS::EKS::Addon
  AWS::Glue::MLTransform
  AWS::IoT::Policy
  AWS::IoT::MitigationAction
  AWS::IoTTwinMaker::Workspace
  AWS::IoTTwinMaker::Entity
  AWS::IoTAnalytics::Dataset
  AWS::IoTAnalytics::Pipeline
  AWS::IoTAnalytics::Channel
  AWS::IoTSiteWise::Dashboard
  AWS::IoTSiteWise::Project
  AWS::IoTSiteWise::Portal
  AWS::IoTSiteWise::AssetModel
  AWS::IVS::Channel
  AWS::IVS::RecordingConfiguration
  AWS::IVS::PlaybackKeyPair
  AWS::KinesisAnalyticsV2::Application
  AWS::RDS::GlobalCluster
  AWS::S3::MultiRegionAccessPoint
  AWS::DeviceFarm::TestGridProject
  AWS::Budgets::BudgetsAction
  AWS::Lex::Bot
  AWS::CodeGuruReviewer::RepositoryAssociation
  AWS::IoT::CustomMetric
  AWS::Route53Resolver::FirewallDomainList
  AWS::RoboMaker::RobotApplicationVersion
  AWS::EC2::TrafficMirrorSession
  AWS::IoTSiteWise::Gateway
  AWS::Lex::BotAlias
  AWS::LookoutMetrics::Alert
  AWS::IoT::AccountAuditConfiguration
  AWS::EC2::TrafficMirrorTarget
  AWS::S3::StorageLens
  AWS::IoT::ScheduledAudit
  AWS::Events::Connection
  AWS::EventSchemas::Schema
  AWS::MediaPackage::PackagingConfiguration
  AWS::KinesisVideo::SignalingChannel
  AWS::AppStream::DirectoryConfig
  AWS::LookoutVision::Project
  AWS::Route53RecoveryControl::Cluster
  AWS::Route53RecoveryControl::SafetyRule
  AWS::Route53RecoveryControl::ControlPanel
  AWS::Route53RecoveryControl::RoutingControl
  AWS::Route53RecoveryReadiness::ResourceSet
  AWS::RoboMaker::SimulationApplication
  AWS::RoboMaker::RobotApplication
  AWS::HealthLake::FHIRDatastore
  AWS::Pinpoint::Segment
  AWS::Pinpoint::ApplicationSettings
  AWS::Events::Rule
  AWS::EC2::DHCPOptions
  AWS::EC2::NetworkInsightsPath
  AWS::EC2::TrafficMirrorFilter
  AWS::EC2::IPAM
  AWS::IoTTwinMaker::Scene
  AWS::NetworkManager::TransitGatewayRegistration
  AWS::CustomerProfiles::Domain
  AWS::AutoScaling::WarmPool
  AWS::Connect::PhoneNumber
  AWS::AppConfig::DeploymentStrategy
  AWS::AppFlow::Flow
  AWS::AuditManager::Assessment
  AWS::CloudWatch::MetricStream
  AWS::DeviceFarm::InstanceProfile
  AWS::DeviceFarm::Project
  AWS::EC2::EC2Fleet
  AWS::EC2::SubnetRouteTableAssociation
  AWS::ECR::PullThroughCacheRule
  AWS::GroundStation::Config
  AWS::ImageBuilder::ImagePipeline
  AWS::IoT::FleetMetric
  AWS::IoTWireless::ServiceProfile
  AWS::NetworkManager::Device
  AWS::NetworkManager::GlobalNetwork
  AWS::NetworkManager::Link
  AWS::NetworkManager::Site
  AWS::Panorama::Package
  AWS::Pinpoint::App
  AWS::Redshift::ScheduledAction
  AWS::Route53Resolver::FirewallRuleGroupAssociation
  AWS::SageMaker::AppImageConfig
  AWS::SageMaker::Image
  AWS::ECS::TaskSet
  AWS::Cassandra::Keyspace
  AWS::Signer::SigningProfile
  AWS::Amplify::App
  AWS::AppMesh::VirtualNode
  AWS::AppMesh::VirtualService
  AWS::AppRunner::VpcConnector
  AWS::AppStream::Application
  AWS::CodeArtifact::Repository
  AWS::EC2::PrefixList
  AWS::EC2::SpotFleet
  AWS::Evidently::Project
  AWS::Forecast::Dataset
  AWS::IAM::SAMLProvider
  AWS::IAM::ServerCertificate
  AWS::Pinpoint::Campaign
  AWS::Pinpoint::InAppTemplate
  AWS::SageMaker::Domain
  AWS::Transfer::Agreement
  AWS::Transfer::Connector
  AWS::KinesisFirehose::DeliveryStream
  AWS::Amplify::Branch
  AWS::AppIntegrations::EventIntegration
  AWS::AppMesh::Route
  AWS::Athena::PreparedStatement
  AWS::EC2::IPAMScope
  AWS::Evidently::Launch
  AWS::Forecast::DatasetGroup
  AWS::GreengrassV2::ComponentVersion
  AWS::GroundStation::MissionProfile
  AWS::MediaConnect::FlowEntitlement
  AWS::MediaConnect::FlowVpcInterface
  AWS::MediaTailor::PlaybackConfiguration
  AWS::MSK::Configuration
  AWS::Personalize::Dataset
  AWS::Personalize::Schema
  AWS::Personalize::Solution
  AWS::Pinpoint::EmailTemplate
  AWS::Pinpoint::EventStream
  AWS::ResilienceHub::App
  AWS::ACMPCA::CertificateAuthority
  AWS::AppConfig::HostedConfigurationVersion
  AWS::AppMesh::VirtualGateway
  AWS::AppMesh::VirtualRouter
  AWS::AppRunner::Service
  AWS::CustomerProfiles::ObjectType
  AWS::DMS::Endpoint
  AWS::EC2::CapacityReservation
  AWS::EC2::ClientVpnEndpoint
  AWS::Kendra::Index
  AWS::KinesisVideo::Stream
  AWS::Logs::Destination
  AWS::Pinpoint::EmailChannel
  AWS::S3::AccessPoint
  AWS::NetworkManager::CustomerGatewayAssociation
  AWS::NetworkManager::LinkAssociation
  AWS::IoTWireless::MulticastGroup
  AWS::Personalize::DatasetGroup
  AWS::IoTTwinMaker::ComponentType
  AWS::CodeBuild::ReportGroup
  AWS::SageMaker::FeatureGroup
  AWS::MSK::BatchScramSecret
  AWS::AppStream::Stack
  AWS::IoT::JobTemplate
  AWS::IoTWireless::FuotaTask
  AWS::IoT::ProvisioningTemplate
  AWS::InspectorV2::Filter
  AWS::Route53Resolver::ResolverQueryLoggingConfigAssociation
  AWS::ServiceDiscovery::Instance
  AWS::Transfer::Certificate
  AWS::MediaConnect::FlowSource
  AWS::APS::RuleGroupsNamespace
  AWS::CodeGuruProfiler::ProfilingGroup
  AWS::Route53Resolver::ResolverQueryLoggingConfig
  AWS::Batch::SchedulingPolicy
  AWS::ACMPCA::CertificateAuthorityActivation
  AWS::AppMesh::GatewayRoute
  AWS::AppMesh::Mesh
  AWS::Connect::Instance
  AWS::Connect::QuickConnect
  AWS::EC2::CarrierGateway
  AWS::EC2::IPAMPool
  AWS::EC2::TransitGatewayConnect
  AWS::EC2::TransitGatewayMulticastDomain
  AWS::ECS::CapacityProvider
  AWS::IAM::InstanceProfile
  AWS::IoT::CACertificate
  AWS::IoTTwinMaker::SyncJob
  AWS::KafkaConnect::Connector
  AWS::Lambda::CodeSigningConfig
  AWS::NetworkManager::ConnectPeer
  AWS::ResourceExplorer2::Index
  AWS::AppStream::Fleet
  AWS::Cognito::UserPool
  AWS::Cognito::UserPoolClient
  AWS::Cognito::UserPoolGroup
  AWS::EC2::NetworkInsightsAccessScope
  AWS::EC2::NetworkInsightsAnalysis
  AWS::Grafana::Workspace
  AWS::GroundStation::DataflowEndpointGroup
  AWS::ImageBuilder::ImageRecipe
  AWS::KMS::Alias
  AWS::M2::Environment
  AWS::QuickSight::DataSource
  AWS::QuickSight::Template
  AWS::QuickSight::Theme
  AWS::RDS::OptionGroup
  AWS::Redshift::EndpointAccess
  AWS::Route53Resolver::FirewallRuleGroup
  AWS::SSM::Document

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

• json
• text
• table
• yaml
• yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

• base64
• raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

ConfigurationRecorder -> (structure)

Records configuration changes to the resource types in scope.

For more information about the configuration recorder, see ` Working with the Configuration Recorder https://docs.aws.amazon.com/config/latest/developerguide/stop-start-recorder.html`__ in the Config Developer Guide .

arn -> (string)

The Amazon Resource Name (ARN) of the specified configuration recorder.

name -> (string)

The name of the configuration recorder.

For customer managed configuration recorders, Config automatically assigns the name of “default” when creating a configuration recorder if you do not specify a name at creation time.

For service-linked configuration recorders, Config automatically assigns a name that has the prefix “AWS “ to a new service-linked configuration recorder.

Note

Changing the name of a configuration recorder

To change the name of the customer managed configuration recorder, you must delete it and create a new customer managed configuration recorder with a new name.

You cannot change the name of a service-linked configuration recorder.

roleARN -> (string)

The Amazon Resource Name (ARN) of the IAM role assumed by Config and used by the specified configuration recorder.

Note

The server will reject a request without a defined ``roleARN`` for the configuration recorder

While the API model does not require this field, the server will reject a request without a defined roleARN for the configuration recorder.

Policies and compliance results

IAM policies and other policies managed in Organizations can impact whether Config has permissions to record configuration changes for your resources. Additionally, rules directly evaluate the configuration of a resource and rules don’t take into account these policies when running evaluations. Make sure that the policies in effect align with how you intend to use Config.

Keep Minimum Permisions When Reusing an IAM role

If you use an Amazon Web Services service that uses Config, such as Security Hub or Control Tower, and an IAM role has already been created, make sure that the IAM role that you use when setting up Config keeps the same minimum permissions as the pre-existing IAM role. You must do this to ensure that the other Amazon Web Services service continues to run as expected.

For example, if Control Tower has an IAM role that allows Config to read S3 objects, make sure that the same permissions are granted to the IAM role you use when setting up Config. Otherwise, it may interfere with how Control Tower operates.

The service-linked IAM role for Config must be used for service-linked configuration recorders

For service-linked configuration recorders, you must use the service-linked IAM role for Config: AWSServiceRoleForConfig .

recordingGroup -> (structure)

Specifies which resource types are in scope for the configuration recorder to record.

Note

High Number of Config Evaluations

You might notice increased activity in your account during your initial month recording with Config when compared to subsequent months. During the initial bootstrapping process, Config runs evaluations on all the resources in your account that you have selected for Config to record.

If you are running ephemeral workloads, you may see increased activity from Config as it records configuration changes associated with creating and deleting these temporary resources. An ephemeral workload is a temporary use of computing resources that are loaded and run when needed. Examples include Amazon Elastic Compute Cloud (Amazon EC2) Spot Instances, Amazon EMR jobs, and Auto Scaling.

If you want to avoid the increased activity from running ephemeral workloads, you can set up the configuration recorder to exclude these resource types from being recorded, or run these types of workloads in a separate account with Config turned off to avoid increased configuration recording and rule evaluations.

allSupported -> (boolean)

Specifies whether Config records configuration changes for all supported resource types, excluding the global IAM resource types.

If you set this field to true , when Config adds support for a new resource type, Config starts recording resources of that type automatically.

If you set this field to true , you cannot enumerate specific resource types to record in the resourceTypes field of RecordingGroup , or to exclude in the resourceTypes field of ExclusionByResourceTypes .

Note

Region availability

Check Resource Coverage by Region Availability to see if a resource type is supported in the Amazon Web Services Region where you set up Config.

includeGlobalResourceTypes -> (boolean)

This option is a bundle which only applies to the global IAM resource types: IAM users, groups, roles, and customer managed policies. These global IAM resource types can only be recorded by Config in Regions where Config was available before February 2022. You cannot be record the global IAM resouce types in Regions supported by Config after February 2022. For a list of those Regions, see Recording Amazon Web Services Resources | Global Resources .

Warning

Aurora global clusters are recorded in all enabled Regions

The AWS::RDS::GlobalCluster resource type will be recorded in all supported Config Regions where the configuration recorder is enabled, even if includeGlobalResourceTypes is set``false`` . The includeGlobalResourceTypes option is a bundle which only applies to IAM users, groups, roles, and customer managed policies.

If you do not want to record AWS::RDS::GlobalCluster in all enabled Regions, use one of the following recording strategies:

• Record all current and future resource types with exclusions (EXCLUSION_BY_RESOURCE_TYPES ), or
• Record specific resource types (INCLUSION_BY_RESOURCE_TYPES ).

For more information, see Selecting Which Resources are Recorded in the Config developer guide .

Warning

includeGlobalResourceTypes and the exclusion recording strategy

The includeGlobalResourceTypes field has no impact on the EXCLUSION_BY_RESOURCE_TYPES recording strategy. This means that the global IAM resource types (IAM users, groups, roles, and customer managed policies) will not be automatically added as exclusions for exclusionByResourceTypes when includeGlobalResourceTypes is set to false .

The includeGlobalResourceTypes field should only be used to modify the AllSupported field, as the default for the AllSupported field is to record configuration changes for all supported resource types excluding the global IAM resource types. To include the global IAM resource types when AllSupported is set to true , make sure to set includeGlobalResourceTypes to true .

To exclude the global IAM resource types for the EXCLUSION_BY_RESOURCE_TYPES recording strategy, you need to manually add them to the resourceTypes field of exclusionByResourceTypes .

Note

Required and optional fields

Before you set this field to true , set the allSupported field of RecordingGroup to true . Optionally, you can set the useOnly field of RecordingStrategy to ALL_SUPPORTED_RESOURCE_TYPES .

Note

Overriding fields

If you set this field to false but list global IAM resource types in the resourceTypes field of RecordingGroup , Config will still record configuration changes for those specified resource types regardless of if you set the includeGlobalResourceTypes field to false.

If you do not want to record configuration changes to the global IAM resource types (IAM users, groups, roles, and customer managed policies), make sure to not list them in the resourceTypes field in addition to setting the includeGlobalResourceTypes field to false.

resourceTypes -> (list)

A comma-separated list that specifies which resource types Config records.

For a list of valid resourceTypes values, see the Resource Type Value column in Supported Amazon Web Services resource Types in the Config developer guide .

Note

Required and optional fields

Optionally, you can set the useOnly field of RecordingStrategy to INCLUSION_BY_RESOURCE_TYPES .

To record all configuration changes, set the allSupported field of RecordingGroup to true , and either omit this field or don’t specify any resource types in this field. If you set the allSupported field to false and specify values for resourceTypes , when Config adds support for a new type of resource, it will not record resources of that type unless you manually add that type to your recording group.

Note

Region availability

Before specifying a resource type for Config to track, check Resource Coverage by Region Availability to see if the resource type is supported in the Amazon Web Services Region where you set up Config. If a resource type is supported by Config in at least one Region, you can enable the recording of that resource type in all Regions supported by Config, even if the specified resource type is not supported in the Amazon Web Services Region where you set up Config.

(string)

exclusionByResourceTypes -> (structure)

An object that specifies how Config excludes resource types from being recorded by the configuration recorder.

Note

Required fields

To use this option, you must set the useOnly field of RecordingStrategy to EXCLUSION_BY_RESOURCE_TYPES .

resourceTypes -> (list)

A comma-separated list of resource types to exclude from recording by the configuration recorder.

(string)

recordingStrategy -> (structure)

An object that specifies the recording strategy for the configuration recorder.

• If you set the useOnly field of RecordingStrategy to ALL_SUPPORTED_RESOURCE_TYPES , Config records configuration changes for all supported resource types, excluding the global IAM resource types. You also must set the allSupported field of RecordingGroup to true . When Config adds support for a new resource type, Config automatically starts recording resources of that type.
• If you set the useOnly field of RecordingStrategy to INCLUSION_BY_RESOURCE_TYPES , Config records configuration changes for only the resource types you specify in the resourceTypes field of RecordingGroup .
• If you set the useOnly field of RecordingStrategy to EXCLUSION_BY_RESOURCE_TYPES , Config records configuration changes for all supported resource types except the resource types that you specify to exclude from being recorded in the resourceTypes field of ExclusionByResourceTypes .

Note

Required and optional fields

The recordingStrategy field is optional when you set the allSupported field of RecordingGroup to true .

The recordingStrategy field is optional when you list resource types in the resourceTypes field of RecordingGroup .

The recordingStrategy field is required if you list resource types to exclude from recording in the resourceTypes field of ExclusionByResourceTypes .

Note

Overriding fields

If you choose EXCLUSION_BY_RESOURCE_TYPES for the recording strategy, the exclusionByResourceTypes field will override other properties in the request.

For example, even if you set includeGlobalResourceTypes to false, global IAM resource types will still be automatically recorded in this option unless those resource types are specifically listed as exclusions in the resourceTypes field of exclusionByResourceTypes .

Note

Global resources types and the resource exclusion recording strategy

By default, if you choose the EXCLUSION_BY_RESOURCE_TYPES recording strategy, when Config adds support for a new resource type in the Region where you set up the configuration recorder, including global resource types, Config starts recording resources of that type automatically.

Unless specifically listed as exclusions, AWS::RDS::GlobalCluster will be recorded automatically in all supported Config Regions were the configuration recorder is enabled.

IAM users, groups, roles, and customer managed policies will be recorded in the Region where you set up the configuration recorder if that is a Region where Config was available before February 2022. You cannot be record the global IAM resouce types in Regions supported by Config after February 2022. For a list of those Regions, see Recording Amazon Web Services Resources | Global Resources .

useOnly -> (string)

The recording strategy for the configuration recorder.

• If you set this option to ALL_SUPPORTED_RESOURCE_TYPES , Config records configuration changes for all supported resource types, excluding the global IAM resource types. You also must set the allSupported field of RecordingGroup to true . When Config adds support for a new resource type, Config automatically starts recording resources of that type. For a list of supported resource types, see Supported Resource Types in the Config developer guide .
• If you set this option to INCLUSION_BY_RESOURCE_TYPES , Config records configuration changes for only the resource types that you specify in the resourceTypes field of RecordingGroup .
• If you set this option to EXCLUSION_BY_RESOURCE_TYPES , Config records configuration changes for all supported resource types, except the resource types that you specify to exclude from being recorded in the resourceTypes field of ExclusionByResourceTypes .

Note

Required and optional fields

The recordingStrategy field is optional when you set the allSupported field of RecordingGroup to true .

The recordingStrategy field is optional when you list resource types in the resourceTypes field of RecordingGroup .

The recordingStrategy field is required if you list resource types to exclude from recording in the resourceTypes field of ExclusionByResourceTypes .

Note

Overriding fields

If you choose EXCLUSION_BY_RESOURCE_TYPES for the recording strategy, the exclusionByResourceTypes field will override other properties in the request.

For example, even if you set includeGlobalResourceTypes to false, global IAM resource types will still be automatically recorded in this option unless those resource types are specifically listed as exclusions in the resourceTypes field of exclusionByResourceTypes .

Note

Global resource types and the exclusion recording strategy

By default, if you choose the EXCLUSION_BY_RESOURCE_TYPES recording strategy, when Config adds support for a new resource type in the Region where you set up the configuration recorder, including global resource types, Config starts recording resources of that type automatically.

Unless specifically listed as exclusions, AWS::RDS::GlobalCluster will be recorded automatically in all supported Config Regions were the configuration recorder is enabled.

IAM users, groups, roles, and customer managed policies will be recorded in the Region where you set up the configuration recorder if that is a Region where Config was available before February 2022. You cannot be record the global IAM resouce types in Regions supported by Config after February 2022. This list where you cannot record the global IAM resource types includes the following Regions:

• Asia Pacific (Hyderabad)
• Asia Pacific (Melbourne)
• Canada West (Calgary)
• Europe (Spain)
• Europe (Zurich)
• Israel (Tel Aviv)
• Middle East (UAE)

recordingMode -> (structure)

Specifies the default recording frequency for the configuration recorder. Config supports Continuous recording and Daily recording .

• Continuous recording allows you to record configuration changes continuously whenever a change occurs.
• Daily recording allows you to receive a configuration item (CI) representing the most recent state of your resources over the last 24-hour period, only if it’s different from the previous CI recorded.

Note

Some resource types require continuous recording

Firewall Manager depends on continuous recording to monitor your resources. If you are using Firewall Manager, it is recommended that you set the recording frequency to Continuous.

You can also override the recording frequency for specific resource types.

recordingFrequency -> (string)

The default recording frequency that Config uses to record configuration changes.

Warning

Daily recording cannot be specified for the following resource types:

• AWS::Config::ResourceCompliance
• AWS::Config::ConformancePackCompliance
• AWS::Config::ConfigurationRecorder

For the allSupported (ALL_SUPPORTED_RESOURCE_TYPES ) recording strategy, these resource types will be set to Continuous recording.

recordingModeOverrides -> (list)

An array of recordingModeOverride objects for you to specify your overrides for the recording mode. The recordingModeOverride object in the recordingModeOverrides array consists of three fields: a description , the new recordingFrequency , and an array of resourceTypes to override.

(structure)

An object for you to specify your overrides for the recording mode.

description -> (string)

A description that you provide for the override.

resourceTypes -> (list)

A comma-separated list that specifies which resource types Config includes in the override.

Warning

Daily recording cannot be specified for the following resource types:

• AWS::Config::ResourceCompliance
• AWS::Config::ConformancePackCompliance
• AWS::Config::ConfigurationRecorder

(string)

recordingFrequency -> (string)

The recording frequency that will be applied to all the resource types specified in the override.

• Continuous recording allows you to record configuration changes continuously whenever a change occurs.
• Daily recording allows you to receive a configuration item (CI) representing the most recent state of your resources over the last 24-hour period, only if it’s different from the previous CI recorded.

Note

Firewall Manager depends on continuous recording to monitor your resources. If you are using Firewall Manager, it is recommended that you set the recording frequency to Continuous.

recordingScope -> (string)

Specifies whether the ConfigurationItems in scope for the specified configuration recorder are recorded for free (INTERNAL ) or if it impacts the costs to your bill (PAID ).

servicePrincipal -> (string)

For service-linked configuration recorders, specifies the linked Amazon Web Services service for the configuration recorder.