Class: AWSCDK::Greengrass::CfnConnectorDefinition::ConnectorProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
greengrass/cfn_connector_definition.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 ConnectorDefinitionVersion property type contains a list of Connector property types.

See Also:

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 used by the connector.



646
647
648
649
650
651
652
653
 
# File 'greengrass/cfn_connector_definition.rb', line 646

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_arn ⇒ String (readonly)

The Amazon Resource Name (ARN) of the connector.

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

Returns:

  • (String)

See Also:



661
662
663
 
# File 'greengrass/cfn_connector_definition.rb', line 661

def connector_arn
  @connector_arn
end

#id ⇒ String (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:_-]+ .

Returns:

  • (String)

See Also:



668
669
670
 
# File 'greengrass/cfn_connector_definition.rb', line 668

def id
  @id
end

#parameters ⇒ Object? (readonly)

The parameters or configuration used by the connector.

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

Returns:

  • (Object, nil)

See Also:



675
676
677
 
# File 'greengrass/cfn_connector_definition.rb', line 675

def parameters
  @parameters
end

Class Method Details

.jsii_properties ⇒ Object 



677
678
679
680
681
682
683
 
# File 'greengrass/cfn_connector_definition.rb', line 677

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

Instance Method Details

#to_jsii ⇒ Object 



685
686
687
688
689
690
691
692
693
 
# File 'greengrass/cfn_connector_definition.rb', line 685

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