Class: AWSCDK::IoT::CfnAccountAuditConfigurationProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
io_t/cfn_account_audit_configuration_props.rb

Overview

Properties for defining a CfnAccountAuditConfiguration.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(account_id:, audit_check_configurations:, role_arn:, audit_notification_target_configurations: nil) ⇒ CfnAccountAuditConfigurationProps

Returns a new instance of CfnAccountAuditConfigurationProps.

Parameters:



13
14
15
16
17
18
19
20
21
22
 
# File 'io_t/cfn_account_audit_configuration_props.rb', line 13

def initialize(account_id:, audit_check_configurations:, role_arn:, audit_notification_target_configurations: nil)
  @account_id = 
  Jsii::Type.check_type(@account_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "accountId")
  @audit_check_configurations = audit_check_configurations.is_a?(Hash) ? ::AWSCDK::IoT::CfnAccountAuditConfiguration::AuditCheckConfigurationsProperty.new(**audit_check_configurations.transform_keys(&:to_sym)) : audit_check_configurations
  Jsii::Type.check_type(@audit_check_configurations, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19pb3QuQ2ZuQWNjb3VudEF1ZGl0Q29uZmlndXJhdGlvbi5BdWRpdENoZWNrQ29uZmlndXJhdGlvbnNQcm9wZXJ0eSJ9XX19")), "auditCheckConfigurations")
  @role_arn = role_arn
  Jsii::Type.check_type(@role_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "roleArn")
  @audit_notification_target_configurations = audit_notification_target_configurations.is_a?(Hash) ? ::AWSCDK::IoT::CfnAccountAuditConfiguration::AuditNotificationTargetConfigurationsProperty.new(**audit_notification_target_configurations.transform_keys(&:to_sym)) : audit_notification_target_configurations
  Jsii::Type.check_type(@audit_notification_target_configurations, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19pb3QuQ2ZuQWNjb3VudEF1ZGl0Q29uZmlndXJhdGlvbi5BdWRpdE5vdGlmaWNhdGlvblRhcmdldENvbmZpZ3VyYXRpb25zUHJvcGVydHkifV19fQ==")), "auditNotificationTargetConfigurations") unless @audit_notification_target_configurations.nil?
end

Instance Attribute Details

#account_id ⇒ String (readonly)

The ID of the account.

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

Returns:

  • (String)

See Also:



30
31
32
 
# File 'io_t/cfn_account_audit_configuration_props.rb', line 30

def 
  @account_id
end

#audit_check_configurations ⇒ AWSCDK::IResolvable, AWSCDK::IoT::CfnAccountAuditConfiguration::AuditCheckConfigurationsProperty (readonly)

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 available audit checks see AWS::IoT::AccountAuditConfiguration AuditCheckConfigurations

Returns:

See Also:



43
44
45
 
# File 'io_t/cfn_account_audit_configuration_props.rb', line 43

def audit_check_configurations
  @audit_check_configurations
end

#audit_notification_target_configurations ⇒ AWSCDK::IResolvable, ... (readonly)

Information about the targets to which audit notifications are sent.

Returns:

See Also:



53
54
55
 
# File 'io_t/cfn_account_audit_configuration_props.rb', line 53

def audit_notification_target_configurations
  @audit_notification_target_configurations
end

#role_arn ⇒ String (readonly)

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.

Returns:

  • (String)

See Also:



48
49
50
 
# File 'io_t/cfn_account_audit_configuration_props.rb', line 48

def role_arn
  @role_arn
end

Class Method Details

.jsii_properties ⇒ Object 



55
56
57
58
59
60
61
62
 
# File 'io_t/cfn_account_audit_configuration_props.rb', line 55

def self.jsii_properties
  {
    :account_id => "accountId",
    :audit_check_configurations => "auditCheckConfigurations",
    :role_arn => "roleArn",
    :audit_notification_target_configurations => "auditNotificationTargetConfigurations",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



64
65
66
67
68
69
70
71
72
73
 
# File 'io_t/cfn_account_audit_configuration_props.rb', line 64

def to_jsii
  result = {}
  result.merge!({
    "accountId" => @account_id,
    "auditCheckConfigurations" => @audit_check_configurations,
    "roleArn" => @role_arn,
    "auditNotificationTargetConfigurations" => @audit_notification_target_configurations,
  })
  result.compact
end