Class: AWSCDK::IoT::CfnProvisioningTemplate::ProvisioningHookProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::IoT::CfnProvisioningTemplate::ProvisioningHookProperty

Defined in:

io_t/cfn_provisioning_template.rb

Overview

Structure that contains payloadVersion and targetArn.

Provisioning hooks can be used when fleet provisioning to validate device parameters before allowing the device to be provisioned.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-provisioningtemplate-provisioninghook.html

Instance Attribute Summary

• #payload_version ⇒ String^? readonly

  The payload that was sent to the target function.

• #target_arn ⇒ String^? readonly

  The ARN of the target function.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(payload_version: nil, target_arn: nil) ⇒ ProvisioningHookProperty constructor

  A new instance of ProvisioningHookProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(payload_version: nil, target_arn: nil) ⇒ ProvisioningHookProperty

Returns a new instance of ProvisioningHookProperty.

Parameters:

• payload_version (String, nil) (defaults to: nil) —

  The payload that was sent to the target function.

• target_arn (String, nil) (defaults to: nil) —

  The ARN of the target function.

# File 'io_t/cfn_provisioning_template.rb', line 625

def initialize(payload_version: nil, target_arn: nil)
  @payload_version = payload_version
  Jsii::Type.check_type(@payload_version, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "payloadVersion") unless @payload_version.nil?
  @target_arn = target_arn
  Jsii::Type.check_type(@target_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "targetArn") unless @target_arn.nil?
end

Instance Attribute Details

#payload_version ⇒ String^? (readonly)

The payload that was sent to the target function.

The valid payload is "2020-04-01" .

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-provisioningtemplate-provisioninghook.html#cfn-iot-provisioningtemplate-provisioninghook-payloadversion

# File 'io_t/cfn_provisioning_template.rb', line 638

def payload_version
  @payload_version
end

#target_arn ⇒ String^? (readonly)

The ARN of the target function.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-provisioningtemplate-provisioninghook.html#cfn-iot-provisioningtemplate-provisioninghook-targetarn

# File 'io_t/cfn_provisioning_template.rb', line 643

def target_arn
  @target_arn
end

Class Method Details

.jsii_properties ⇒ Object

# File 'io_t/cfn_provisioning_template.rb', line 645

def self.jsii_properties
  {
    :payload_version => "payloadVersion",
    :target_arn => "targetArn",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'io_t/cfn_provisioning_template.rb', line 652

def to_jsii
  result = {}
  result.merge!({
    "payloadVersion" => @payload_version,
    "targetArn" => @target_arn,
  })
  result.compact
end