Class: AWSCDK::Greengrass::CfnConnectorDefinitionVersion::ConnectorProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
greengrass/cfn_connector_definition_version.rb

Overview

Connectors are modules that provide built-in integration with local infrastructure, device protocols, AWS , and other cloud services.

For more information, see Integrate with Services and Protocols Using Greengrass Connectors in the Developer Guide .

In an CloudFormation template, the Connectors property of the AWS::Greengrass::ConnectorDefinitionVersion resource contains a list of Connector property types.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(connector_arn:, id:, parameters: nil) ⇒ ConnectorProperty

Returns a new instance of ConnectorProperty.

Parameters:

  • connector_arn (String)

    The Amazon Resource Name (ARN) of the connector.

  • id (String)

    A descriptive or arbitrary ID for the connector.

  • parameters (Object, nil) (defaults to: nil)

    The parameters or configuration that the connector uses.



523
524
525
526
527
528
529
530
# File 'greengrass/cfn_connector_definition_version.rb', line 523

def initialize(connector_arn:, id:, parameters: nil)
  @connector_arn = connector_arn
  Jsii::Type.check_type(@connector_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "connectorArn")
  @id = id
  Jsii::Type.check_type(@id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  @parameters = parameters
  Jsii::Type.check_type(@parameters, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "parameters") unless @parameters.nil?
end

Instance Attribute Details

#connector_arnString (readonly)

The Amazon Resource Name (ARN) of the connector.

For more information about connectors provided by AWS , see Greengrass Connectors Provided by AWS .



538
539
540
# File 'greengrass/cfn_connector_definition_version.rb', line 538

def connector_arn
  @connector_arn
end

#idString (readonly)

A descriptive or arbitrary ID for the connector.

This value must be unique within the connector definition version. Maximum length is 128 characters with pattern [a-zA-Z0-9:_-]+ .



545
546
547
# File 'greengrass/cfn_connector_definition_version.rb', line 545

def id
  @id
end

#parametersObject? (readonly)

The parameters or configuration that the connector uses.

For more information about connectors provided by AWS , see Greengrass Connectors Provided by AWS .



552
553
554
# File 'greengrass/cfn_connector_definition_version.rb', line 552

def parameters
  @parameters
end

Class Method Details

.jsii_propertiesObject



554
555
556
557
558
559
560
# File 'greengrass/cfn_connector_definition_version.rb', line 554

def self.jsii_properties
  {
    :connector_arn => "connectorArn",
    :id => "id",
    :parameters => "parameters",
  }
end

Instance Method Details

#to_jsiiObject



562
563
564
565
566
567
568
569
570
# File 'greengrass/cfn_connector_definition_version.rb', line 562

def to_jsii
  result = {}
  result.merge!({
    "connectorArn" => @connector_arn,
    "id" => @id,
    "parameters" => @parameters,
  })
  result.compact
end