aws-cdk-lib.aws_iot.CfnAccountAuditConfigurationProps

interface CfnAccountAuditConfigurationProps

LanguageType name
.NETAmazon.CDK.AWS.IoT.CfnAccountAuditConfigurationProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsiot#CfnAccountAuditConfigurationProps
Javasoftware.amazon.awscdk.services.iot.CfnAccountAuditConfigurationProps
Pythonaws_cdk.aws_iot.CfnAccountAuditConfigurationProps
TypeScript aws-cdk-lib » aws_iot » CfnAccountAuditConfigurationProps

Properties for defining a CfnAccountAuditConfiguration.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_iot as iot } from 'aws-cdk-lib';
const cfnAccountAuditConfigurationProps: iot.CfnAccountAuditConfigurationProps = {
  accountId: 'accountId',
  auditCheckConfigurations: {
    authenticatedCognitoRoleOverlyPermissiveCheck: {
      enabled: false,
    },
    caCertificateExpiringCheck: {
      enabled: false,
    },
    caCertificateKeyQualityCheck: {
      enabled: false,
    },
    conflictingClientIdsCheck: {
      enabled: false,
    },
    deviceCertificateExpiringCheck: {
      enabled: false,
    },
    deviceCertificateKeyQualityCheck: {
      enabled: false,
    },
    deviceCertificateSharedCheck: {
      enabled: false,
    },
    intermediateCaRevokedForActiveDeviceCertificatesCheck: {
      enabled: false,
    },
    iotPolicyOverlyPermissiveCheck: {
      enabled: false,
    },
    ioTPolicyPotentialMisConfigurationCheck: {
      enabled: false,
    },
    iotRoleAliasAllowsAccessToUnusedServicesCheck: {
      enabled: false,
    },
    iotRoleAliasOverlyPermissiveCheck: {
      enabled: false,
    },
    loggingDisabledCheck: {
      enabled: false,
    },
    revokedCaCertificateStillActiveCheck: {
      enabled: false,
    },
    revokedDeviceCertificateStillActiveCheck: {
      enabled: false,
    },
    unauthenticatedCognitoRoleOverlyPermissiveCheck: {
      enabled: false,
    },
  },
  roleArn: 'roleArn',

  // the properties below are optional
  auditNotificationTargetConfigurations: {
    sns: {
      enabled: false,
      roleArn: 'roleArn',
      targetArn: 'targetArn',
    },
  },
};

Properties

NameTypeDescription
accountIdstringThe ID of the account.
auditCheckConfigurationsIResolvable | AuditCheckConfigurationsPropertySpecifies which audit checks are enabled and disabled for this account.
roleArnstringThe Amazon Resource Name (ARN) of the role that grants permission to AWS IoT to access information about your devices, policies, certificates, and other items as required when performing an audit.
auditNotificationTargetConfigurations?IResolvable | AuditNotificationTargetConfigurationsPropertyInformation about the targets to which audit notifications are sent.

accountId

Type: string

The ID of the account.

You can use the expression !Sub "${AWS::AccountId}" to use your account ID.


auditCheckConfigurations

Type: IResolvable | AuditCheckConfigurationsProperty

Specifies which audit checks are enabled and disabled for this account.

Some data collection might start immediately when certain checks are enabled. When a check is disabled, any data collected so far in relation to the check is deleted. To disable a check, set the value of the Enabled: key to false .

If an enabled check is removed from the template, it will also be disabled.

You can't disable a check if it's used by any scheduled audit. You must delete the check from the scheduled audit or delete the scheduled audit itself to disable the check.

For more information on avialbe auidt checks see AWS::IoT::AccountAuditConfiguration AuditCheckConfigurations


roleArn

Type: string

The Amazon Resource Name (ARN) of the role that grants permission to AWS IoT to access information about your devices, policies, certificates, and other items as required when performing an audit.


auditNotificationTargetConfigurations?

Type: IResolvable | AuditNotificationTargetConfigurationsProperty (optional)

Information about the targets to which audit notifications are sent.