CfnAccountAuditConfiguration¶
-
class
aws_cdk.aws_iot.
CfnAccountAuditConfiguration
(scope, id, *, account_id, audit_check_configurations, role_arn, audit_notification_target_configurations=None)¶ Bases:
aws_cdk.core.CfnResource
A CloudFormation
AWS::IoT::AccountAuditConfiguration
.Use the
AWS::IoT::AccountAuditConfiguration
resource to configure or reconfigure the Device Defender audit settings for your account. Settings include how audit notifications are sent and which audit checks are enabled or disabled. For API reference, see UpdateAccountAuditConfiguration and for detailed information on all available audit checks, see Audit checks .- CloudformationResource
AWS::IoT::AccountAuditConfiguration
- Link
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_iot as iot cfn_account_audit_configuration = iot.CfnAccountAuditConfiguration(self, "MyCfnAccountAuditConfiguration", account_id="accountId", audit_check_configurations=iot.CfnAccountAuditConfiguration.AuditCheckConfigurationsProperty( authenticated_cognito_role_overly_permissive_check=iot.CfnAccountAuditConfiguration.AuditCheckConfigurationProperty( enabled=False ), ca_certificate_expiring_check=iot.CfnAccountAuditConfiguration.AuditCheckConfigurationProperty( enabled=False ), ca_certificate_key_quality_check=iot.CfnAccountAuditConfiguration.AuditCheckConfigurationProperty( enabled=False ), conflicting_client_ids_check=iot.CfnAccountAuditConfiguration.AuditCheckConfigurationProperty( enabled=False ), device_certificate_expiring_check=iot.CfnAccountAuditConfiguration.AuditCheckConfigurationProperty( enabled=False ), device_certificate_key_quality_check=iot.CfnAccountAuditConfiguration.AuditCheckConfigurationProperty( enabled=False ), device_certificate_shared_check=iot.CfnAccountAuditConfiguration.AuditCheckConfigurationProperty( enabled=False ), iot_policy_overly_permissive_check=iot.CfnAccountAuditConfiguration.AuditCheckConfigurationProperty( enabled=False ), iot_role_alias_allows_access_to_unused_services_check=iot.CfnAccountAuditConfiguration.AuditCheckConfigurationProperty( enabled=False ), iot_role_alias_overly_permissive_check=iot.CfnAccountAuditConfiguration.AuditCheckConfigurationProperty( enabled=False ), logging_disabled_check=iot.CfnAccountAuditConfiguration.AuditCheckConfigurationProperty( enabled=False ), revoked_ca_certificate_still_active_check=iot.CfnAccountAuditConfiguration.AuditCheckConfigurationProperty( enabled=False ), revoked_device_certificate_still_active_check=iot.CfnAccountAuditConfiguration.AuditCheckConfigurationProperty( enabled=False ), unauthenticated_cognito_role_overly_permissive_check=iot.CfnAccountAuditConfiguration.AuditCheckConfigurationProperty( enabled=False ) ), role_arn="roleArn", # the properties below are optional audit_notification_target_configurations=iot.CfnAccountAuditConfiguration.AuditNotificationTargetConfigurationsProperty( sns=iot.CfnAccountAuditConfiguration.AuditNotificationTargetProperty( enabled=False, role_arn="roleArn", target_arn="targetArn" ) ) )
Create a new
AWS::IoT::AccountAuditConfiguration
.- Parameters
scope (
Construct
) –scope in which this resource is defined.
id (
str
) –scoped id of the resource.
account_id (
str
) – The ID of the account. You can use the expression!Sub "${AWS::AccountId}"
to use your account ID.audit_check_configurations (
Union
[AuditCheckConfigurationsProperty
,IResolvable
]) – 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 theEnabled:
key tofalse
. 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 AuditCheckConfigurationsrole_arn (
str
) – 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.audit_notification_target_configurations (
Union
[IResolvable
,AuditNotificationTargetConfigurationsProperty
,None
]) – Information about the targets to which audit notifications are sent.
Methods
-
add_deletion_override
(path)¶ Syntactic sugar for
addOverride(path, undefined)
.- Parameters
path (
str
) – The path of the value to delete.- Return type
None
-
add_depends_on
(target)¶ Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
- Parameters
target (
CfnResource
) –- Return type
None
-
add_metadata
(key, value)¶ Add a value to the CloudFormation Resource Metadata.
- Parameters
key (
str
) –value (
Any
) –
- See
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- Return type
None
-
add_override
(path, value)¶ Adds an override to the synthesized CloudFormation resource.
To add a property override, either use
addPropertyOverride
or prefixpath
with “Properties.” (i.e.Properties.TopicName
).If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.
To include a literal
.
in the property name, prefix with a\
. In most programming languages you will need to write this as"\\."
because the\
itself will need to be escaped.For example:
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"]) cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")
would add the overrides Example:
"Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... }
The
value
argument toaddOverride
will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.- Parameters
path (
str
) –The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
value (
Any
) –The value. Could be primitive or complex.
- Return type
None
-
add_property_deletion_override
(property_path)¶ Adds an override that deletes the value of a property from the resource definition.
- Parameters
property_path (
str
) – The path to the property.- Return type
None
-
add_property_override
(property_path, value)¶ Adds an override to a resource property.
Syntactic sugar for
addOverride("Properties.<...>", value)
.- Parameters
property_path (
str
) – The path of the property.value (
Any
) – The value.
- Return type
None
-
apply_removal_policy
(policy=None, *, apply_to_update_replace_policy=None, default=None)¶ Sets the deletion policy of the resource based on the removal policy specified.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.
The resource can be deleted (
RemovalPolicy.DESTROY
), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN
).- Parameters
policy (
Optional
[RemovalPolicy
]) –apply_to_update_replace_policy (
Optional
[bool
]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: truedefault (
Optional
[RemovalPolicy
]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.
- Return type
None
-
get_att
(attribute_name)¶ Returns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g.
resource.arn
), but this can be used for future compatibility in case there is no generated attribute.- Parameters
attribute_name (
str
) – The name of the attribute.- Return type
-
get_metadata
(key)¶ Retrieve a value value from the CloudFormation Resource Metadata.
- Parameters
key (
str
) –- See
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- Return type
Any
-
inspect
(inspector)¶ Examines the CloudFormation resource and discloses attributes.
- Parameters
inspector (
TreeInspector
) –tree inspector to collect and process attributes.
- Return type
None
-
override_logical_id
(new_logical_id)¶ Overrides the auto-generated logical ID with a specific ID.
- Parameters
new_logical_id (
str
) – The new logical ID to use for this stack element.- Return type
None
-
to_string
()¶ Returns a string representation of this construct.
- Return type
str
- Returns
a string representation of this resource
Attributes
-
CFN_RESOURCE_TYPE_NAME
= 'AWS::IoT::AccountAuditConfiguration'¶
-
account_id
¶ The ID of the account.
You can use the expression
!Sub "${AWS::AccountId}"
to use your account ID.
-
audit_check_configurations
¶ 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 tofalse
.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
-
audit_notification_target_configurations
¶ Information about the targets to which audit notifications are sent.
-
cfn_options
¶ Options for this resource, such as condition, update policy etc.
- Return type
-
cfn_resource_type
¶ AWS resource type.
- Return type
str
-
creation_stack
¶ return:
the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.
- Return type
List
[str
]
-
logical_id
¶ The logical ID for this CloudFormation stack element.
The logical ID of the element is calculated from the path of the resource node in the construct tree.
To override this value, use
overrideLogicalId(newLogicalId)
.- Return type
str
- Returns
the logical ID as a stringified token. This value will only get resolved during synthesis.
-
node
¶ The construct tree node associated with this construct.
- Return type
-
ref
¶ Return a string that will be resolved to a CloudFormation
{ Ref }
for this element.If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through
Lazy.any({ produce: resource.ref })
.- Return type
str
-
role_arn
¶ 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.
-
stack
¶ The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
- Return type
Static Methods
-
classmethod
is_cfn_element
(x)¶ Returns
true
if a construct is a stack element (i.e. part of the synthesized cloudformation template).Uses duck-typing instead of
instanceof
to allow stack elements from different versions of this library to be included in the same stack.- Parameters
x (
Any
) –- Return type
bool
- Returns
The construct as a stack element or undefined if it is not a stack element.
-
classmethod
is_cfn_resource
(construct)¶ Check whether the given construct is a CfnResource.
- Parameters
construct (
IConstruct
) –- Return type
bool
-
classmethod
is_construct
(x)¶ Return whether the given object is a Construct.
- Parameters
x (
Any
) –- Return type
bool
AuditCheckConfigurationProperty¶
-
class
CfnAccountAuditConfiguration.
AuditCheckConfigurationProperty
(*, enabled=None)¶ Bases:
object
Which audit checks are enabled and disabled for this account.
- Parameters
enabled (
Union
[bool
,IResolvable
,None
]) – True if this audit check is enabled for this account.- Link
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_iot as iot audit_check_configuration_property = iot.CfnAccountAuditConfiguration.AuditCheckConfigurationProperty( enabled=False )
Attributes
-
enabled
¶ True if this audit check is enabled for this account.
AuditCheckConfigurationsProperty¶
-
class
CfnAccountAuditConfiguration.
AuditCheckConfigurationsProperty
(*, authenticated_cognito_role_overly_permissive_check=None, ca_certificate_expiring_check=None, ca_certificate_key_quality_check=None, conflicting_client_ids_check=None, device_certificate_expiring_check=None, device_certificate_key_quality_check=None, device_certificate_shared_check=None, iot_policy_overly_permissive_check=None, iot_role_alias_allows_access_to_unused_services_check=None, iot_role_alias_overly_permissive_check=None, logging_disabled_check=None, revoked_ca_certificate_still_active_check=None, revoked_device_certificate_still_active_check=None, unauthenticated_cognito_role_overly_permissive_check=None)¶ Bases:
object
The types of audit checks that can be performed.
- Parameters
authenticated_cognito_role_overly_permissive_check (
Union
[IResolvable
,AuditCheckConfigurationProperty
,None
]) – Checks the permissiveness of an authenticated Amazon Cognito identity pool role. For this check, AWS IoT Device Defender audits all Amazon Cognito identity pools that have been used to connect to the AWS IoT message broker during the 31 days before the audit is performed.ca_certificate_expiring_check (
Union
[IResolvable
,AuditCheckConfigurationProperty
,None
]) – Checks if a CA certificate is expiring. This check applies to CA certificates expiring within 30 days or that have expired.ca_certificate_key_quality_check (
Union
[IResolvable
,AuditCheckConfigurationProperty
,None
]) – Checks the quality of the CA certificate key. The quality checks if the key is in a valid format, not expired, and if the key meets a minimum required size. This check applies to CA certificates that areACTIVE
orPENDING_TRANSFER
.conflicting_client_ids_check (
Union
[IResolvable
,AuditCheckConfigurationProperty
,None
]) – Checks if multiple devices connect using the same client ID.device_certificate_expiring_check (
Union
[IResolvable
,AuditCheckConfigurationProperty
,None
]) – Checks if a device certificate is expiring. This check applies to device certificates expiring within 30 days or that have expired.device_certificate_key_quality_check (
Union
[IResolvable
,AuditCheckConfigurationProperty
,None
]) – Checks the quality of the device certificate key. The quality checks if the key is in a valid format, not expired, signed by a registered certificate authority, and if the key meets a minimum required size.device_certificate_shared_check (
Union
[IResolvable
,AuditCheckConfigurationProperty
,None
]) – Checks if multiple concurrent connections use the same X.509 certificate to authenticate with AWS IoT .iot_policy_overly_permissive_check (
Union
[IResolvable
,AuditCheckConfigurationProperty
,None
]) – Checks the permissiveness of a policy attached to an authenticated Amazon Cognito identity pool role.iot_role_alias_allows_access_to_unused_services_check (
Union
[IResolvable
,AuditCheckConfigurationProperty
,None
]) – Checks if a role alias has access to services that haven’t been used for the AWS IoT device in the last year.iot_role_alias_overly_permissive_check (
Union
[IResolvable
,AuditCheckConfigurationProperty
,None
]) – Checks if the temporary credentials provided by AWS IoT role aliases are overly permissive.logging_disabled_check (
Union
[IResolvable
,AuditCheckConfigurationProperty
,None
]) – Checks if AWS IoT logs are disabled.revoked_ca_certificate_still_active_check (
Union
[IResolvable
,AuditCheckConfigurationProperty
,None
]) – Checks if a revoked CA certificate is still active.revoked_device_certificate_still_active_check (
Union
[IResolvable
,AuditCheckConfigurationProperty
,None
]) – Checks if a revoked device certificate is still active.unauthenticated_cognito_role_overly_permissive_check (
Union
[IResolvable
,AuditCheckConfigurationProperty
,None
]) – Checks if policy attached to an unauthenticated Amazon Cognito identity pool role is too permissive.
- Link
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_iot as iot audit_check_configurations_property = iot.CfnAccountAuditConfiguration.AuditCheckConfigurationsProperty( authenticated_cognito_role_overly_permissive_check=iot.CfnAccountAuditConfiguration.AuditCheckConfigurationProperty( enabled=False ), ca_certificate_expiring_check=iot.CfnAccountAuditConfiguration.AuditCheckConfigurationProperty( enabled=False ), ca_certificate_key_quality_check=iot.CfnAccountAuditConfiguration.AuditCheckConfigurationProperty( enabled=False ), conflicting_client_ids_check=iot.CfnAccountAuditConfiguration.AuditCheckConfigurationProperty( enabled=False ), device_certificate_expiring_check=iot.CfnAccountAuditConfiguration.AuditCheckConfigurationProperty( enabled=False ), device_certificate_key_quality_check=iot.CfnAccountAuditConfiguration.AuditCheckConfigurationProperty( enabled=False ), device_certificate_shared_check=iot.CfnAccountAuditConfiguration.AuditCheckConfigurationProperty( enabled=False ), iot_policy_overly_permissive_check=iot.CfnAccountAuditConfiguration.AuditCheckConfigurationProperty( enabled=False ), iot_role_alias_allows_access_to_unused_services_check=iot.CfnAccountAuditConfiguration.AuditCheckConfigurationProperty( enabled=False ), iot_role_alias_overly_permissive_check=iot.CfnAccountAuditConfiguration.AuditCheckConfigurationProperty( enabled=False ), logging_disabled_check=iot.CfnAccountAuditConfiguration.AuditCheckConfigurationProperty( enabled=False ), revoked_ca_certificate_still_active_check=iot.CfnAccountAuditConfiguration.AuditCheckConfigurationProperty( enabled=False ), revoked_device_certificate_still_active_check=iot.CfnAccountAuditConfiguration.AuditCheckConfigurationProperty( enabled=False ), unauthenticated_cognito_role_overly_permissive_check=iot.CfnAccountAuditConfiguration.AuditCheckConfigurationProperty( enabled=False ) )
Attributes
-
authenticated_cognito_role_overly_permissive_check
¶ Checks the permissiveness of an authenticated Amazon Cognito identity pool role.
For this check, AWS IoT Device Defender audits all Amazon Cognito identity pools that have been used to connect to the AWS IoT message broker during the 31 days before the audit is performed.
- Link
- Return type
Union
[IResolvable
,AuditCheckConfigurationProperty
,None
]
-
ca_certificate_expiring_check
¶ Checks if a CA certificate is expiring.
This check applies to CA certificates expiring within 30 days or that have expired.
-
ca_certificate_key_quality_check
¶ Checks the quality of the CA certificate key.
The quality checks if the key is in a valid format, not expired, and if the key meets a minimum required size. This check applies to CA certificates that are
ACTIVE
orPENDING_TRANSFER
.
-
conflicting_client_ids_check
¶ Checks if multiple devices connect using the same client ID.
-
device_certificate_expiring_check
¶ Checks if a device certificate is expiring.
This check applies to device certificates expiring within 30 days or that have expired.
- Link
- Return type
Union
[IResolvable
,AuditCheckConfigurationProperty
,None
]
-
device_certificate_key_quality_check
¶ Checks the quality of the device certificate key.
The quality checks if the key is in a valid format, not expired, signed by a registered certificate authority, and if the key meets a minimum required size.
- Link
- Return type
Union
[IResolvable
,AuditCheckConfigurationProperty
,None
]
Checks if multiple concurrent connections use the same X.509 certificate to authenticate with AWS IoT .
-
iot_policy_overly_permissive_check
¶ Checks the permissiveness of a policy attached to an authenticated Amazon Cognito identity pool role.
- Link
- Return type
Union
[IResolvable
,AuditCheckConfigurationProperty
,None
]
-
iot_role_alias_allows_access_to_unused_services_check
¶ Checks if a role alias has access to services that haven’t been used for the AWS IoT device in the last year.
- Link
- Return type
Union
[IResolvable
,AuditCheckConfigurationProperty
,None
]
-
iot_role_alias_overly_permissive_check
¶ Checks if the temporary credentials provided by AWS IoT role aliases are overly permissive.
- Link
- Return type
Union
[IResolvable
,AuditCheckConfigurationProperty
,None
]
-
logging_disabled_check
¶ Checks if AWS IoT logs are disabled.
-
revoked_ca_certificate_still_active_check
¶ Checks if a revoked CA certificate is still active.
- Link
- Return type
Union
[IResolvable
,AuditCheckConfigurationProperty
,None
]
-
revoked_device_certificate_still_active_check
¶ Checks if a revoked device certificate is still active.
- Link
- Return type
Union
[IResolvable
,AuditCheckConfigurationProperty
,None
]
-
unauthenticated_cognito_role_overly_permissive_check
¶ Checks if policy attached to an unauthenticated Amazon Cognito identity pool role is too permissive.
- Link
- Return type
Union
[IResolvable
,AuditCheckConfigurationProperty
,None
]
AuditNotificationTargetConfigurationsProperty¶
-
class
CfnAccountAuditConfiguration.
AuditNotificationTargetConfigurationsProperty
(*, sns=None)¶ Bases:
object
The configuration of the audit notification target.
- Parameters
sns (
Union
[IResolvable
,AuditNotificationTargetProperty
,None
]) – TheSns
notification target.- Link
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_iot as iot audit_notification_target_configurations_property = iot.CfnAccountAuditConfiguration.AuditNotificationTargetConfigurationsProperty( sns=iot.CfnAccountAuditConfiguration.AuditNotificationTargetProperty( enabled=False, role_arn="roleArn", target_arn="targetArn" ) )
Attributes
-
sns
¶ The
Sns
notification target.- Link
- Return type
Union
[IResolvable
,AuditNotificationTargetProperty
,None
]
AuditNotificationTargetProperty¶
-
class
CfnAccountAuditConfiguration.
AuditNotificationTargetProperty
(*, enabled=None, role_arn=None, target_arn=None)¶ Bases:
object
Information about the targets to which audit notifications are sent.
- Parameters
enabled (
Union
[bool
,IResolvable
,None
]) – True if notifications to the target are enabled.role_arn (
Optional
[str
]) – The ARN of the role that grants permission to send notifications to the target.target_arn (
Optional
[str
]) – The ARN of the target (SNS topic) to which audit notifications are sent.
- Link
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_iot as iot audit_notification_target_property = iot.CfnAccountAuditConfiguration.AuditNotificationTargetProperty( enabled=False, role_arn="roleArn", target_arn="targetArn" )
Attributes
-
enabled
¶ True if notifications to the target are enabled.
-
role_arn
¶ The ARN of the role that grants permission to send notifications to the target.
-
target_arn
¶ The ARN of the target (SNS topic) to which audit notifications are sent.