Documentation
¶
Index ¶
- func CfnConnectorDefinitionVersion_CFN_RESOURCE_TYPE_NAME() *string
- func CfnConnectorDefinitionVersion_IsCfnElement(x interface{}) *bool
- func CfnConnectorDefinitionVersion_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnConnectorDefinitionVersion_IsConstruct(x interface{}) *bool
- func CfnConnectorDefinition_CFN_RESOURCE_TYPE_NAME() *string
- func CfnConnectorDefinition_IsCfnElement(x interface{}) *bool
- func CfnConnectorDefinition_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnConnectorDefinition_IsConstruct(x interface{}) *bool
- func CfnCoreDefinitionVersion_CFN_RESOURCE_TYPE_NAME() *string
- func CfnCoreDefinitionVersion_IsCfnElement(x interface{}) *bool
- func CfnCoreDefinitionVersion_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnCoreDefinitionVersion_IsConstruct(x interface{}) *bool
- func CfnCoreDefinition_CFN_RESOURCE_TYPE_NAME() *string
- func CfnCoreDefinition_IsCfnElement(x interface{}) *bool
- func CfnCoreDefinition_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnCoreDefinition_IsConstruct(x interface{}) *bool
- func CfnDeviceDefinitionVersion_CFN_RESOURCE_TYPE_NAME() *string
- func CfnDeviceDefinitionVersion_IsCfnElement(x interface{}) *bool
- func CfnDeviceDefinitionVersion_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnDeviceDefinitionVersion_IsConstruct(x interface{}) *bool
- func CfnDeviceDefinition_CFN_RESOURCE_TYPE_NAME() *string
- func CfnDeviceDefinition_IsCfnElement(x interface{}) *bool
- func CfnDeviceDefinition_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnDeviceDefinition_IsConstruct(x interface{}) *bool
- func CfnFunctionDefinitionVersion_CFN_RESOURCE_TYPE_NAME() *string
- func CfnFunctionDefinitionVersion_IsCfnElement(x interface{}) *bool
- func CfnFunctionDefinitionVersion_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnFunctionDefinitionVersion_IsConstruct(x interface{}) *bool
- func CfnFunctionDefinition_CFN_RESOURCE_TYPE_NAME() *string
- func CfnFunctionDefinition_IsCfnElement(x interface{}) *bool
- func CfnFunctionDefinition_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnFunctionDefinition_IsConstruct(x interface{}) *bool
- func CfnGroupVersion_CFN_RESOURCE_TYPE_NAME() *string
- func CfnGroupVersion_IsCfnElement(x interface{}) *bool
- func CfnGroupVersion_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnGroupVersion_IsConstruct(x interface{}) *bool
- func CfnGroup_CFN_RESOURCE_TYPE_NAME() *string
- func CfnGroup_IsCfnElement(x interface{}) *bool
- func CfnGroup_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnGroup_IsConstruct(x interface{}) *bool
- func CfnLoggerDefinitionVersion_CFN_RESOURCE_TYPE_NAME() *string
- func CfnLoggerDefinitionVersion_IsCfnElement(x interface{}) *bool
- func CfnLoggerDefinitionVersion_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnLoggerDefinitionVersion_IsConstruct(x interface{}) *bool
- func CfnLoggerDefinition_CFN_RESOURCE_TYPE_NAME() *string
- func CfnLoggerDefinition_IsCfnElement(x interface{}) *bool
- func CfnLoggerDefinition_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnLoggerDefinition_IsConstruct(x interface{}) *bool
- func CfnResourceDefinitionVersion_CFN_RESOURCE_TYPE_NAME() *string
- func CfnResourceDefinitionVersion_IsCfnElement(x interface{}) *bool
- func CfnResourceDefinitionVersion_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnResourceDefinitionVersion_IsConstruct(x interface{}) *bool
- func CfnResourceDefinition_CFN_RESOURCE_TYPE_NAME() *string
- func CfnResourceDefinition_IsCfnElement(x interface{}) *bool
- func CfnResourceDefinition_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnResourceDefinition_IsConstruct(x interface{}) *bool
- func CfnSubscriptionDefinitionVersion_CFN_RESOURCE_TYPE_NAME() *string
- func CfnSubscriptionDefinitionVersion_IsCfnElement(x interface{}) *bool
- func CfnSubscriptionDefinitionVersion_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnSubscriptionDefinitionVersion_IsConstruct(x interface{}) *bool
- func CfnSubscriptionDefinition_CFN_RESOURCE_TYPE_NAME() *string
- func CfnSubscriptionDefinition_IsCfnElement(x interface{}) *bool
- func CfnSubscriptionDefinition_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnSubscriptionDefinition_IsConstruct(x interface{}) *bool
- func NewCfnConnectorDefinitionVersion_Override(c CfnConnectorDefinitionVersion, scope constructs.Construct, id *string, ...)
- func NewCfnConnectorDefinition_Override(c CfnConnectorDefinition, scope constructs.Construct, id *string, ...)
- func NewCfnCoreDefinitionVersion_Override(c CfnCoreDefinitionVersion, scope constructs.Construct, id *string, ...)
- func NewCfnCoreDefinition_Override(c CfnCoreDefinition, scope constructs.Construct, id *string, ...)
- func NewCfnDeviceDefinitionVersion_Override(c CfnDeviceDefinitionVersion, scope constructs.Construct, id *string, ...)
- func NewCfnDeviceDefinition_Override(c CfnDeviceDefinition, scope constructs.Construct, id *string, ...)
- func NewCfnFunctionDefinitionVersion_Override(c CfnFunctionDefinitionVersion, scope constructs.Construct, id *string, ...)
- func NewCfnFunctionDefinition_Override(c CfnFunctionDefinition, scope constructs.Construct, id *string, ...)
- func NewCfnGroupVersion_Override(c CfnGroupVersion, scope constructs.Construct, id *string, ...)
- func NewCfnGroup_Override(c CfnGroup, scope constructs.Construct, id *string, props *CfnGroupProps)
- func NewCfnLoggerDefinitionVersion_Override(c CfnLoggerDefinitionVersion, scope constructs.Construct, id *string, ...)
- func NewCfnLoggerDefinition_Override(c CfnLoggerDefinition, scope constructs.Construct, id *string, ...)
- func NewCfnResourceDefinitionVersion_Override(c CfnResourceDefinitionVersion, scope constructs.Construct, id *string, ...)
- func NewCfnResourceDefinition_Override(c CfnResourceDefinition, scope constructs.Construct, id *string, ...)
- func NewCfnSubscriptionDefinitionVersion_Override(c CfnSubscriptionDefinitionVersion, scope constructs.Construct, id *string, ...)
- func NewCfnSubscriptionDefinition_Override(c CfnSubscriptionDefinition, scope constructs.Construct, id *string, ...)
- type CfnConnectorDefinition
- type CfnConnectorDefinitionProps
- type CfnConnectorDefinitionVersion
- type CfnConnectorDefinitionVersionProps
- type CfnConnectorDefinitionVersion_ConnectorProperty
- type CfnConnectorDefinition_ConnectorDefinitionVersionProperty
- type CfnConnectorDefinition_ConnectorProperty
- type CfnCoreDefinition
- type CfnCoreDefinitionProps
- type CfnCoreDefinitionVersion
- type CfnCoreDefinitionVersionProps
- type CfnCoreDefinitionVersion_CoreProperty
- type CfnCoreDefinition_CoreDefinitionVersionProperty
- type CfnCoreDefinition_CoreProperty
- type CfnDeviceDefinition
- type CfnDeviceDefinitionProps
- type CfnDeviceDefinitionVersion
- type CfnDeviceDefinitionVersionProps
- type CfnDeviceDefinitionVersion_DeviceProperty
- type CfnDeviceDefinition_DeviceDefinitionVersionProperty
- type CfnDeviceDefinition_DeviceProperty
- type CfnFunctionDefinition
- type CfnFunctionDefinitionProps
- type CfnFunctionDefinitionVersion
- type CfnFunctionDefinitionVersionProps
- type CfnFunctionDefinitionVersion_DefaultConfigProperty
- type CfnFunctionDefinitionVersion_EnvironmentProperty
- type CfnFunctionDefinitionVersion_ExecutionProperty
- type CfnFunctionDefinitionVersion_FunctionConfigurationProperty
- type CfnFunctionDefinitionVersion_FunctionProperty
- type CfnFunctionDefinitionVersion_ResourceAccessPolicyProperty
- type CfnFunctionDefinitionVersion_RunAsProperty
- type CfnFunctionDefinition_DefaultConfigProperty
- type CfnFunctionDefinition_EnvironmentProperty
- type CfnFunctionDefinition_ExecutionProperty
- type CfnFunctionDefinition_FunctionConfigurationProperty
- type CfnFunctionDefinition_FunctionDefinitionVersionProperty
- type CfnFunctionDefinition_FunctionProperty
- type CfnFunctionDefinition_ResourceAccessPolicyProperty
- type CfnFunctionDefinition_RunAsProperty
- type CfnGroup
- type CfnGroupProps
- type CfnGroupVersion
- type CfnGroupVersionProps
- type CfnGroup_GroupVersionProperty
- type CfnLoggerDefinition
- type CfnLoggerDefinitionProps
- type CfnLoggerDefinitionVersion
- type CfnLoggerDefinitionVersionProps
- type CfnLoggerDefinitionVersion_LoggerProperty
- type CfnLoggerDefinition_LoggerDefinitionVersionProperty
- type CfnLoggerDefinition_LoggerProperty
- type CfnResourceDefinition
- type CfnResourceDefinitionProps
- type CfnResourceDefinitionVersion
- type CfnResourceDefinitionVersionProps
- type CfnResourceDefinitionVersion_GroupOwnerSettingProperty
- type CfnResourceDefinitionVersion_LocalDeviceResourceDataProperty
- type CfnResourceDefinitionVersion_LocalVolumeResourceDataProperty
- type CfnResourceDefinitionVersion_ResourceDataContainerProperty
- type CfnResourceDefinitionVersion_ResourceDownloadOwnerSettingProperty
- type CfnResourceDefinitionVersion_ResourceInstanceProperty
- type CfnResourceDefinitionVersion_S3MachineLearningModelResourceDataProperty
- type CfnResourceDefinitionVersion_SageMakerMachineLearningModelResourceDataProperty
- type CfnResourceDefinitionVersion_SecretsManagerSecretResourceDataProperty
- type CfnResourceDefinition_GroupOwnerSettingProperty
- type CfnResourceDefinition_LocalDeviceResourceDataProperty
- type CfnResourceDefinition_LocalVolumeResourceDataProperty
- type CfnResourceDefinition_ResourceDataContainerProperty
- type CfnResourceDefinition_ResourceDefinitionVersionProperty
- type CfnResourceDefinition_ResourceDownloadOwnerSettingProperty
- type CfnResourceDefinition_ResourceInstanceProperty
- type CfnResourceDefinition_S3MachineLearningModelResourceDataProperty
- type CfnResourceDefinition_SageMakerMachineLearningModelResourceDataProperty
- type CfnResourceDefinition_SecretsManagerSecretResourceDataProperty
- type CfnSubscriptionDefinition
- type CfnSubscriptionDefinitionProps
- type CfnSubscriptionDefinitionVersion
- type CfnSubscriptionDefinitionVersionProps
- type CfnSubscriptionDefinitionVersion_SubscriptionProperty
- type CfnSubscriptionDefinition_SubscriptionDefinitionVersionProperty
- type CfnSubscriptionDefinition_SubscriptionProperty
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CfnConnectorDefinitionVersion_CFN_RESOURCE_TYPE_NAME ¶
func CfnConnectorDefinitionVersion_CFN_RESOURCE_TYPE_NAME() *string
func CfnConnectorDefinitionVersion_IsCfnElement ¶
func CfnConnectorDefinitionVersion_IsCfnElement(x interface{}) *bool
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.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnConnectorDefinitionVersion_IsCfnResource ¶
func CfnConnectorDefinitionVersion_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnConnectorDefinitionVersion_IsConstruct ¶
func CfnConnectorDefinitionVersion_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead.
func CfnConnectorDefinition_CFN_RESOURCE_TYPE_NAME ¶
func CfnConnectorDefinition_CFN_RESOURCE_TYPE_NAME() *string
func CfnConnectorDefinition_IsCfnElement ¶
func CfnConnectorDefinition_IsCfnElement(x interface{}) *bool
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.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnConnectorDefinition_IsCfnResource ¶
func CfnConnectorDefinition_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnConnectorDefinition_IsConstruct ¶
func CfnConnectorDefinition_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead.
func CfnCoreDefinitionVersion_CFN_RESOURCE_TYPE_NAME ¶
func CfnCoreDefinitionVersion_CFN_RESOURCE_TYPE_NAME() *string
func CfnCoreDefinitionVersion_IsCfnElement ¶
func CfnCoreDefinitionVersion_IsCfnElement(x interface{}) *bool
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.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnCoreDefinitionVersion_IsCfnResource ¶
func CfnCoreDefinitionVersion_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnCoreDefinitionVersion_IsConstruct ¶
func CfnCoreDefinitionVersion_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead.
func CfnCoreDefinition_CFN_RESOURCE_TYPE_NAME ¶
func CfnCoreDefinition_CFN_RESOURCE_TYPE_NAME() *string
func CfnCoreDefinition_IsCfnElement ¶
func CfnCoreDefinition_IsCfnElement(x interface{}) *bool
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.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnCoreDefinition_IsCfnResource ¶
func CfnCoreDefinition_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnCoreDefinition_IsConstruct ¶
func CfnCoreDefinition_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead.
func CfnDeviceDefinitionVersion_CFN_RESOURCE_TYPE_NAME ¶
func CfnDeviceDefinitionVersion_CFN_RESOURCE_TYPE_NAME() *string
func CfnDeviceDefinitionVersion_IsCfnElement ¶
func CfnDeviceDefinitionVersion_IsCfnElement(x interface{}) *bool
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.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnDeviceDefinitionVersion_IsCfnResource ¶
func CfnDeviceDefinitionVersion_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnDeviceDefinitionVersion_IsConstruct ¶
func CfnDeviceDefinitionVersion_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead.
func CfnDeviceDefinition_CFN_RESOURCE_TYPE_NAME ¶
func CfnDeviceDefinition_CFN_RESOURCE_TYPE_NAME() *string
func CfnDeviceDefinition_IsCfnElement ¶
func CfnDeviceDefinition_IsCfnElement(x interface{}) *bool
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.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnDeviceDefinition_IsCfnResource ¶
func CfnDeviceDefinition_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnDeviceDefinition_IsConstruct ¶
func CfnDeviceDefinition_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead.
func CfnFunctionDefinitionVersion_CFN_RESOURCE_TYPE_NAME ¶
func CfnFunctionDefinitionVersion_CFN_RESOURCE_TYPE_NAME() *string
func CfnFunctionDefinitionVersion_IsCfnElement ¶
func CfnFunctionDefinitionVersion_IsCfnElement(x interface{}) *bool
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.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnFunctionDefinitionVersion_IsCfnResource ¶
func CfnFunctionDefinitionVersion_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnFunctionDefinitionVersion_IsConstruct ¶
func CfnFunctionDefinitionVersion_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead.
func CfnFunctionDefinition_CFN_RESOURCE_TYPE_NAME ¶
func CfnFunctionDefinition_CFN_RESOURCE_TYPE_NAME() *string
func CfnFunctionDefinition_IsCfnElement ¶
func CfnFunctionDefinition_IsCfnElement(x interface{}) *bool
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.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnFunctionDefinition_IsCfnResource ¶
func CfnFunctionDefinition_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnFunctionDefinition_IsConstruct ¶
func CfnFunctionDefinition_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead.
func CfnGroupVersion_CFN_RESOURCE_TYPE_NAME ¶
func CfnGroupVersion_CFN_RESOURCE_TYPE_NAME() *string
func CfnGroupVersion_IsCfnElement ¶
func CfnGroupVersion_IsCfnElement(x interface{}) *bool
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.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnGroupVersion_IsCfnResource ¶
func CfnGroupVersion_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnGroupVersion_IsConstruct ¶
func CfnGroupVersion_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead.
func CfnGroup_CFN_RESOURCE_TYPE_NAME ¶
func CfnGroup_CFN_RESOURCE_TYPE_NAME() *string
func CfnGroup_IsCfnElement ¶
func CfnGroup_IsCfnElement(x interface{}) *bool
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.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnGroup_IsCfnResource ¶
func CfnGroup_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnGroup_IsConstruct ¶
func CfnGroup_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead.
func CfnLoggerDefinitionVersion_CFN_RESOURCE_TYPE_NAME ¶
func CfnLoggerDefinitionVersion_CFN_RESOURCE_TYPE_NAME() *string
func CfnLoggerDefinitionVersion_IsCfnElement ¶
func CfnLoggerDefinitionVersion_IsCfnElement(x interface{}) *bool
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.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnLoggerDefinitionVersion_IsCfnResource ¶
func CfnLoggerDefinitionVersion_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnLoggerDefinitionVersion_IsConstruct ¶
func CfnLoggerDefinitionVersion_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead.
func CfnLoggerDefinition_CFN_RESOURCE_TYPE_NAME ¶
func CfnLoggerDefinition_CFN_RESOURCE_TYPE_NAME() *string
func CfnLoggerDefinition_IsCfnElement ¶
func CfnLoggerDefinition_IsCfnElement(x interface{}) *bool
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.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnLoggerDefinition_IsCfnResource ¶
func CfnLoggerDefinition_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnLoggerDefinition_IsConstruct ¶
func CfnLoggerDefinition_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead.
func CfnResourceDefinitionVersion_CFN_RESOURCE_TYPE_NAME ¶
func CfnResourceDefinitionVersion_CFN_RESOURCE_TYPE_NAME() *string
func CfnResourceDefinitionVersion_IsCfnElement ¶
func CfnResourceDefinitionVersion_IsCfnElement(x interface{}) *bool
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.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnResourceDefinitionVersion_IsCfnResource ¶
func CfnResourceDefinitionVersion_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnResourceDefinitionVersion_IsConstruct ¶
func CfnResourceDefinitionVersion_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead.
func CfnResourceDefinition_CFN_RESOURCE_TYPE_NAME ¶
func CfnResourceDefinition_CFN_RESOURCE_TYPE_NAME() *string
func CfnResourceDefinition_IsCfnElement ¶
func CfnResourceDefinition_IsCfnElement(x interface{}) *bool
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.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnResourceDefinition_IsCfnResource ¶
func CfnResourceDefinition_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnResourceDefinition_IsConstruct ¶
func CfnResourceDefinition_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead.
func CfnSubscriptionDefinitionVersion_CFN_RESOURCE_TYPE_NAME ¶
func CfnSubscriptionDefinitionVersion_CFN_RESOURCE_TYPE_NAME() *string
func CfnSubscriptionDefinitionVersion_IsCfnElement ¶
func CfnSubscriptionDefinitionVersion_IsCfnElement(x interface{}) *bool
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.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnSubscriptionDefinitionVersion_IsCfnResource ¶
func CfnSubscriptionDefinitionVersion_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnSubscriptionDefinitionVersion_IsConstruct ¶
func CfnSubscriptionDefinitionVersion_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead.
func CfnSubscriptionDefinition_CFN_RESOURCE_TYPE_NAME ¶
func CfnSubscriptionDefinition_CFN_RESOURCE_TYPE_NAME() *string
func CfnSubscriptionDefinition_IsCfnElement ¶
func CfnSubscriptionDefinition_IsCfnElement(x interface{}) *bool
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.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnSubscriptionDefinition_IsCfnResource ¶
func CfnSubscriptionDefinition_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnSubscriptionDefinition_IsConstruct ¶
func CfnSubscriptionDefinition_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead.
func NewCfnConnectorDefinitionVersion_Override ¶
func NewCfnConnectorDefinitionVersion_Override(c CfnConnectorDefinitionVersion, scope constructs.Construct, id *string, props *CfnConnectorDefinitionVersionProps)
Create a new `AWS::Greengrass::ConnectorDefinitionVersion`.
func NewCfnConnectorDefinition_Override ¶
func NewCfnConnectorDefinition_Override(c CfnConnectorDefinition, scope constructs.Construct, id *string, props *CfnConnectorDefinitionProps)
Create a new `AWS::Greengrass::ConnectorDefinition`.
func NewCfnCoreDefinitionVersion_Override ¶
func NewCfnCoreDefinitionVersion_Override(c CfnCoreDefinitionVersion, scope constructs.Construct, id *string, props *CfnCoreDefinitionVersionProps)
Create a new `AWS::Greengrass::CoreDefinitionVersion`.
func NewCfnCoreDefinition_Override ¶
func NewCfnCoreDefinition_Override(c CfnCoreDefinition, scope constructs.Construct, id *string, props *CfnCoreDefinitionProps)
Create a new `AWS::Greengrass::CoreDefinition`.
func NewCfnDeviceDefinitionVersion_Override ¶
func NewCfnDeviceDefinitionVersion_Override(c CfnDeviceDefinitionVersion, scope constructs.Construct, id *string, props *CfnDeviceDefinitionVersionProps)
Create a new `AWS::Greengrass::DeviceDefinitionVersion`.
func NewCfnDeviceDefinition_Override ¶
func NewCfnDeviceDefinition_Override(c CfnDeviceDefinition, scope constructs.Construct, id *string, props *CfnDeviceDefinitionProps)
Create a new `AWS::Greengrass::DeviceDefinition`.
func NewCfnFunctionDefinitionVersion_Override ¶
func NewCfnFunctionDefinitionVersion_Override(c CfnFunctionDefinitionVersion, scope constructs.Construct, id *string, props *CfnFunctionDefinitionVersionProps)
Create a new `AWS::Greengrass::FunctionDefinitionVersion`.
func NewCfnFunctionDefinition_Override ¶
func NewCfnFunctionDefinition_Override(c CfnFunctionDefinition, scope constructs.Construct, id *string, props *CfnFunctionDefinitionProps)
Create a new `AWS::Greengrass::FunctionDefinition`.
func NewCfnGroupVersion_Override ¶
func NewCfnGroupVersion_Override(c CfnGroupVersion, scope constructs.Construct, id *string, props *CfnGroupVersionProps)
Create a new `AWS::Greengrass::GroupVersion`.
func NewCfnGroup_Override ¶
func NewCfnGroup_Override(c CfnGroup, scope constructs.Construct, id *string, props *CfnGroupProps)
Create a new `AWS::Greengrass::Group`.
func NewCfnLoggerDefinitionVersion_Override ¶
func NewCfnLoggerDefinitionVersion_Override(c CfnLoggerDefinitionVersion, scope constructs.Construct, id *string, props *CfnLoggerDefinitionVersionProps)
Create a new `AWS::Greengrass::LoggerDefinitionVersion`.
func NewCfnLoggerDefinition_Override ¶
func NewCfnLoggerDefinition_Override(c CfnLoggerDefinition, scope constructs.Construct, id *string, props *CfnLoggerDefinitionProps)
Create a new `AWS::Greengrass::LoggerDefinition`.
func NewCfnResourceDefinitionVersion_Override ¶
func NewCfnResourceDefinitionVersion_Override(c CfnResourceDefinitionVersion, scope constructs.Construct, id *string, props *CfnResourceDefinitionVersionProps)
Create a new `AWS::Greengrass::ResourceDefinitionVersion`.
func NewCfnResourceDefinition_Override ¶
func NewCfnResourceDefinition_Override(c CfnResourceDefinition, scope constructs.Construct, id *string, props *CfnResourceDefinitionProps)
Create a new `AWS::Greengrass::ResourceDefinition`.
func NewCfnSubscriptionDefinitionVersion_Override ¶
func NewCfnSubscriptionDefinitionVersion_Override(c CfnSubscriptionDefinitionVersion, scope constructs.Construct, id *string, props *CfnSubscriptionDefinitionVersionProps)
Create a new `AWS::Greengrass::SubscriptionDefinitionVersion`.
func NewCfnSubscriptionDefinition_Override ¶
func NewCfnSubscriptionDefinition_Override(c CfnSubscriptionDefinition, scope constructs.Construct, id *string, props *CfnSubscriptionDefinitionProps)
Create a new `AWS::Greengrass::SubscriptionDefinition`.
Types ¶
type CfnConnectorDefinition ¶
type CfnConnectorDefinition interface {
awscdk.CfnResource
awscdk.IInspectable
// The Amazon Resource Name (ARN) of the `ConnectorDefinition` , such as `arn:aws:greengrass:us-east-1: :/greengrass/definition/connectors/1234a5b6-78cd-901e-2fgh-3i45j6k178l9` .
AttrArn() *string
// The ID of the `ConnectorDefinition` , such as `1234a5b6-78cd-901e-2fgh-3i45j6k178l9` .
AttrId() *string
// The ARN of the last `ConnectorDefinitionVersion` that was added to the `ConnectorDefinition` , such as `arn:aws:greengrass:us-east-1: :/greengrass/definition/connectors/1234a5b6-78cd-901e-2fgh-3i45j6k178l9/versions/9876ac30-4bdb-4f9d-95af-b5fdb66be1a2` .
AttrLatestVersionArn() *string
// The name of the `ConnectorDefinition` , such as `MyConnectorDefinition` .
AttrName() *string
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
// Returns: 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.
CreationStack() *[]*string
// The connector definition version to include when the connector definition is created.
//
// A connector definition version contains a list of [`connector`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-connectordefinition-connector.html) property types.
//
// > To associate a connector definition version after the connector definition is created, create an [`AWS::Greengrass::ConnectorDefinitionVersion`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-connectordefinitionversion.html) resource and specify the ID of this connector definition.
InitialVersion() interface{}
SetInitialVersion(val interface{})
// 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)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
LogicalId() *string
// The name of the connector definition.
Name() *string
SetName(val *string)
// The tree node.
Node() constructs.Node
// 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 })`.
Ref() *string
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// Application-specific metadata to attach to the connector definition.
//
// You can use tags in IAM policies to control access to AWS IoT Greengrass resources. You can also use tags to categorize your resources. For more information, see [Tagging Your AWS IoT Greengrass Resources](https://docs.aws.amazon.com/greengrass/latest/developerguide/tagging.html) in the *Developer Guide* .
//
// This `Json` property type is processed as a map of key-value pairs. It uses the following format, which is different from most `Tags` implementations in AWS CloudFormation templates.
//
// “`json
// "Tags": { "KeyName0": "value", "KeyName1": "value", "KeyName2": "value"
// }
// “`.
Tags() awscdk.TagManager
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// 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.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// 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.
//
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` 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,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` 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.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
// 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`).
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
// 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.
GetAtt(attributeName *string) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// 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.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::Greengrass::ConnectorDefinition`.
The `AWS::Greengrass::ConnectorDefinition` resource represents a connector definition for AWS IoT Greengrass . Connector definitions are used to organize your connector definition versions.
Connector definitions can reference multiple connector definition versions. All connector definition versions must be associated with a connector definition. Each connector definition version can contain one or more connectors.
> When you create a connector definition, you can optionally include an initial connector definition version. To associate a connector definition version later, create an [`AWS::Greengrass::ConnectorDefinitionVersion`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-connectordefinitionversion.html) resource and specify the ID of this connector definition. > > After you create the connector definition version that contains the connectors you want to deploy, you must add it to your group version. For more information, see [`AWS::Greengrass::Group`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html) .
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import greengrass "github.com/aws/aws-cdk-go/awscdk/aws_greengrass"
var parameters interface{}
var tags interface{}
cfnConnectorDefinition := greengrass.NewCfnConnectorDefinition(this, jsii.String("MyCfnConnectorDefinition"), &cfnConnectorDefinitionProps{
name: jsii.String("name"),
// the properties below are optional
initialVersion: &connectorDefinitionVersionProperty{
connectors: []interface{}{
&connectorProperty{
connectorArn: jsii.String("connectorArn"),
id: jsii.String("id"),
// the properties below are optional
parameters: parameters,
},
},
},
tags: tags,
})
func NewCfnConnectorDefinition ¶
func NewCfnConnectorDefinition(scope constructs.Construct, id *string, props *CfnConnectorDefinitionProps) CfnConnectorDefinition
Create a new `AWS::Greengrass::ConnectorDefinition`.
type CfnConnectorDefinitionProps ¶
type CfnConnectorDefinitionProps struct {
// The name of the connector definition.
Name *string `json:"name" yaml:"name"`
// The connector definition version to include when the connector definition is created.
//
// A connector definition version contains a list of [`connector`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-connectordefinition-connector.html) property types.
//
// > To associate a connector definition version after the connector definition is created, create an [`AWS::Greengrass::ConnectorDefinitionVersion`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-connectordefinitionversion.html) resource and specify the ID of this connector definition.
InitialVersion interface{} `json:"initialVersion" yaml:"initialVersion"`
// Application-specific metadata to attach to the connector definition.
//
// You can use tags in IAM policies to control access to AWS IoT Greengrass resources. You can also use tags to categorize your resources. For more information, see [Tagging Your AWS IoT Greengrass Resources](https://docs.aws.amazon.com/greengrass/latest/developerguide/tagging.html) in the *Developer Guide* .
//
// This `Json` property type is processed as a map of key-value pairs. It uses the following format, which is different from most `Tags` implementations in AWS CloudFormation templates.
//
// “`json
// "Tags": { "KeyName0": "value", "KeyName1": "value", "KeyName2": "value"
// }
// “`.
Tags interface{} `json:"tags" yaml:"tags"`
}
Properties for defining a `CfnConnectorDefinition`.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import greengrass "github.com/aws/aws-cdk-go/awscdk/aws_greengrass"
var parameters interface{}
var tags interface{}
cfnConnectorDefinitionProps := &cfnConnectorDefinitionProps{
name: jsii.String("name"),
// the properties below are optional
initialVersion: &connectorDefinitionVersionProperty{
connectors: []interface{}{
&connectorProperty{
connectorArn: jsii.String("connectorArn"),
id: jsii.String("id"),
// the properties below are optional
parameters: parameters,
},
},
},
tags: tags,
}
type CfnConnectorDefinitionVersion ¶
type CfnConnectorDefinitionVersion interface {
awscdk.CfnResource
awscdk.IInspectable
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
// The ID of the connector definition associated with this version.
//
// This value is a GUID.
ConnectorDefinitionId() *string
SetConnectorDefinitionId(val *string)
// The connectors in this version.
//
// Only one instance of a given connector can be added to the connector definition version at a time.
Connectors() interface{}
SetConnectors(val interface{})
// Returns: 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.
CreationStack() *[]*string
// 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)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
LogicalId() *string
// The tree node.
Node() constructs.Node
// 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 })`.
Ref() *string
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// 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.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// 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.
//
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` 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,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` 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.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
// 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`).
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
// 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.
GetAtt(attributeName *string) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// 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.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::Greengrass::ConnectorDefinitionVersion`.
The `AWS::Greengrass::ConnectorDefinitionVersion` resource represents a connector definition version for AWS IoT Greengrass . A connector definition version contains a list of connectors.
> To create a connector definition version, you must specify the ID of the connector definition that you want to associate with the version. For information about creating a connector definition, see [`AWS::Greengrass::ConnectorDefinition`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-connectordefinition.html) . > > After you create a connector definition version that contains the connectors you want to deploy, you must add it to your group version. For more information, see [`AWS::Greengrass::Group`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html) .
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import greengrass "github.com/aws/aws-cdk-go/awscdk/aws_greengrass"
var parameters interface{}
cfnConnectorDefinitionVersion := greengrass.NewCfnConnectorDefinitionVersion(this, jsii.String("MyCfnConnectorDefinitionVersion"), &cfnConnectorDefinitionVersionProps{
connectorDefinitionId: jsii.String("connectorDefinitionId"),
connectors: []interface{}{
&connectorProperty{
connectorArn: jsii.String("connectorArn"),
id: jsii.String("id"),
// the properties below are optional
parameters: parameters,
},
},
})
func NewCfnConnectorDefinitionVersion ¶
func NewCfnConnectorDefinitionVersion(scope constructs.Construct, id *string, props *CfnConnectorDefinitionVersionProps) CfnConnectorDefinitionVersion
Create a new `AWS::Greengrass::ConnectorDefinitionVersion`.
type CfnConnectorDefinitionVersionProps ¶
type CfnConnectorDefinitionVersionProps struct {
// The ID of the connector definition associated with this version.
//
// This value is a GUID.
ConnectorDefinitionId *string `json:"connectorDefinitionId" yaml:"connectorDefinitionId"`
// The connectors in this version.
//
// Only one instance of a given connector can be added to the connector definition version at a time.
Connectors interface{} `json:"connectors" yaml:"connectors"`
}
Properties for defining a `CfnConnectorDefinitionVersion`.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import greengrass "github.com/aws/aws-cdk-go/awscdk/aws_greengrass"
var parameters interface{}
cfnConnectorDefinitionVersionProps := &cfnConnectorDefinitionVersionProps{
connectorDefinitionId: jsii.String("connectorDefinitionId"),
connectors: []interface{}{
&connectorProperty{
connectorArn: jsii.String("connectorArn"),
id: jsii.String("id"),
// the properties below are optional
parameters: parameters,
},
},
}
type CfnConnectorDefinitionVersion_ConnectorProperty ¶
type CfnConnectorDefinitionVersion_ConnectorProperty struct {
// The Amazon Resource Name (ARN) of the connector.
//
// For more information about connectors provided by AWS , see [Greengrass Connectors Provided by AWS](https://docs.aws.amazon.com/greengrass/latest/developerguide/connectors-list.html) .
ConnectorArn *string `json:"connectorArn" yaml:"connectorArn"`
// 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:_-]+` .
Id *string `json:"id" yaml:"id"`
// The parameters or configuration that the connector uses.
//
// For more information about connectors provided by AWS , see [Greengrass Connectors Provided by AWS](https://docs.aws.amazon.com/greengrass/latest/developerguide/connectors-list.html) .
Parameters interface{} `json:"parameters" yaml:"parameters"`
}
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](https://docs.aws.amazon.com/greengrass/latest/developerguide/connectors.html) in the *Developer Guide* .
In an AWS CloudFormation template, the `Connectors` property of the [`AWS::Greengrass::ConnectorDefinitionVersion`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-connectordefinitionversion.html) resource contains a list of `Connector` property types.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import greengrass "github.com/aws/aws-cdk-go/awscdk/aws_greengrass"
var parameters interface{}
connectorProperty := &connectorProperty{
connectorArn: jsii.String("connectorArn"),
id: jsii.String("id"),
// the properties below are optional
parameters: parameters,
}
type CfnConnectorDefinition_ConnectorDefinitionVersionProperty ¶
type CfnConnectorDefinition_ConnectorDefinitionVersionProperty struct {
// The connectors in this version.
//
// Only one instance of a given connector can be added to a connector definition version at a time.
Connectors interface{} `json:"connectors" yaml:"connectors"`
}
A connector definition version contains a list of connectors.
> After you create a connector definition version that contains the connectors you want to deploy, you must add it to your group version. For more information, see [`AWS::Greengrass::Group`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html) .
In an AWS CloudFormation template, `ConnectorDefinitionVersion` is the property type of the `InitialVersion` property in the [`AWS::Greengrass::ConnectorDefinition`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-connectordefinition.html) resource.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import greengrass "github.com/aws/aws-cdk-go/awscdk/aws_greengrass"
var parameters interface{}
connectorDefinitionVersionProperty := &connectorDefinitionVersionProperty{
connectors: []interface{}{
&connectorProperty{
connectorArn: jsii.String("connectorArn"),
id: jsii.String("id"),
// the properties below are optional
parameters: parameters,
},
},
}
type CfnConnectorDefinition_ConnectorProperty ¶
type CfnConnectorDefinition_ConnectorProperty struct {
// The Amazon Resource Name (ARN) of the connector.
//
// For more information about connectors provided by AWS , see [Greengrass Connectors Provided by AWS](https://docs.aws.amazon.com/greengrass/latest/developerguide/connectors-list.html) .
ConnectorArn *string `json:"connectorArn" yaml:"connectorArn"`
// 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:_-]+` .
Id *string `json:"id" yaml:"id"`
// The parameters or configuration used by the connector.
//
// For more information about connectors provided by AWS , see [Greengrass Connectors Provided by AWS](https://docs.aws.amazon.com/greengrass/latest/developerguide/connectors-list.html) .
Parameters interface{} `json:"parameters" yaml:"parameters"`
}
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](https://docs.aws.amazon.com/greengrass/latest/developerguide/connectors.html) in the *Developer Guide* .
In an AWS CloudFormation template, the `Connectors` property of the [`ConnectorDefinitionVersion`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-connectordefinition-connectordefinitionversion.html) property type contains a list of `Connector` property types.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import greengrass "github.com/aws/aws-cdk-go/awscdk/aws_greengrass"
var parameters interface{}
connectorProperty := &connectorProperty{
connectorArn: jsii.String("connectorArn"),
id: jsii.String("id"),
// the properties below are optional
parameters: parameters,
}
type CfnCoreDefinition ¶
type CfnCoreDefinition interface {
awscdk.CfnResource
awscdk.IInspectable
// The Amazon Resource Name (ARN) of the `CoreDefinition` , such as `arn:aws:greengrass:us-east-1: :/greengrass/definition/cores/1234a5b6-78cd-901e-2fgh-3i45j6k178l9` .
AttrArn() *string
// The ID of the `CoreDefinition` , such as `1234a5b6-78cd-901e-2fgh-3i45j6k178l9` .
AttrId() *string
// The ARN of the last `CoreDefinitionVersion` that was added to the `CoreDefinition` , such as `arn:aws:greengrass:us-east-1: :/greengrass/definition/cores/1234a5b6-78cd-901e-2fgh-3i45j6k178l9/versions/9876ac30-4bdb-4f9d-95af-b5fdb66be1a2` .
AttrLatestVersionArn() *string
// The name of the `CoreDefinition` , such as `MyCoreDefinition` .
AttrName() *string
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
// Returns: 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.
CreationStack() *[]*string
// The core definition version to include when the core definition is created.
//
// Currently, a core definition version can contain only one [`core`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-coredefinition-core.html) .
//
// > To associate a core definition version after the core definition is created, create an [`AWS::Greengrass::CoreDefinitionVersion`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-coredefinitionversion.html) resource and specify the ID of this core definition.
InitialVersion() interface{}
SetInitialVersion(val interface{})
// 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)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
LogicalId() *string
// The name of the core definition.
Name() *string
SetName(val *string)
// The tree node.
Node() constructs.Node
// 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 })`.
Ref() *string
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// Application-specific metadata to attach to the core definition.
//
// You can use tags in IAM policies to control access to AWS IoT Greengrass resources. You can also use tags to categorize your resources. For more information, see [Tagging Your AWS IoT Greengrass Resources](https://docs.aws.amazon.com/greengrass/latest/developerguide/tagging.html) in the *Developer Guide* .
//
// This `Json` property type is processed as a map of key-value pairs. It uses the following format, which is different from most `Tags` implementations in AWS CloudFormation templates.
//
// “`json
// "Tags": { "KeyName0": "value", "KeyName1": "value", "KeyName2": "value"
// }
// “`.
Tags() awscdk.TagManager
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// 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.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// 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.
//
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` 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,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` 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.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
// 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`).
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
// 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.
GetAtt(attributeName *string) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// 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.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::Greengrass::CoreDefinition`.
The `AWS::Greengrass::CoreDefinition` resource represents a core definition for AWS IoT Greengrass . Core definitions are used to organize your core definition versions.
Core definitions can reference multiple core definition versions. All core definition versions must be associated with a core definition. Each core definition version can contain one Greengrass core.
> When you create a core definition, you can optionally include an initial core definition version. To associate a core definition version later, create an [`AWS::Greengrass::CoreDefinitionVersion`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-coredefinitionversion.html) resource and specify the ID of this core definition. > > After you create the core definition version that contains the core you want to deploy, you must add it to your group version. For more information, see [`AWS::Greengrass::Group`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html) .
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import greengrass "github.com/aws/aws-cdk-go/awscdk/aws_greengrass"
var tags interface{}
cfnCoreDefinition := greengrass.NewCfnCoreDefinition(this, jsii.String("MyCfnCoreDefinition"), &cfnCoreDefinitionProps{
name: jsii.String("name"),
// the properties below are optional
initialVersion: &coreDefinitionVersionProperty{
cores: []interface{}{
&coreProperty{
certificateArn: jsii.String("certificateArn"),
id: jsii.String("id"),
thingArn: jsii.String("thingArn"),
// the properties below are optional
syncShadow: jsii.Boolean(false),
},
},
},
tags: tags,
})
func NewCfnCoreDefinition ¶
func NewCfnCoreDefinition(scope constructs.Construct, id *string, props *CfnCoreDefinitionProps) CfnCoreDefinition
Create a new `AWS::Greengrass::CoreDefinition`.
type CfnCoreDefinitionProps ¶
type CfnCoreDefinitionProps struct {
// The name of the core definition.
Name *string `json:"name" yaml:"name"`
// The core definition version to include when the core definition is created.
//
// Currently, a core definition version can contain only one [`core`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-coredefinition-core.html) .
//
// > To associate a core definition version after the core definition is created, create an [`AWS::Greengrass::CoreDefinitionVersion`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-coredefinitionversion.html) resource and specify the ID of this core definition.
InitialVersion interface{} `json:"initialVersion" yaml:"initialVersion"`
// Application-specific metadata to attach to the core definition.
//
// You can use tags in IAM policies to control access to AWS IoT Greengrass resources. You can also use tags to categorize your resources. For more information, see [Tagging Your AWS IoT Greengrass Resources](https://docs.aws.amazon.com/greengrass/latest/developerguide/tagging.html) in the *Developer Guide* .
//
// This `Json` property type is processed as a map of key-value pairs. It uses the following format, which is different from most `Tags` implementations in AWS CloudFormation templates.
//
// “`json
// "Tags": { "KeyName0": "value", "KeyName1": "value", "KeyName2": "value"
// }
// “`.
Tags interface{} `json:"tags" yaml:"tags"`
}
Properties for defining a `CfnCoreDefinition`.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import greengrass "github.com/aws/aws-cdk-go/awscdk/aws_greengrass"
var tags interface{}
cfnCoreDefinitionProps := &cfnCoreDefinitionProps{
name: jsii.String("name"),
// the properties below are optional
initialVersion: &coreDefinitionVersionProperty{
cores: []interface{}{
&coreProperty{
certificateArn: jsii.String("certificateArn"),
id: jsii.String("id"),
thingArn: jsii.String("thingArn"),
// the properties below are optional
syncShadow: jsii.Boolean(false),
},
},
},
tags: tags,
}
type CfnCoreDefinitionVersion ¶
type CfnCoreDefinitionVersion interface {
awscdk.CfnResource
awscdk.IInspectable
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
// The ID of the core definition associated with this version.
//
// This value is a GUID.
CoreDefinitionId() *string
SetCoreDefinitionId(val *string)
// The Greengrass core in this version.
//
// Currently, the `Cores` property for a core definition version can contain only one core.
Cores() interface{}
SetCores(val interface{})
// Returns: 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.
CreationStack() *[]*string
// 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)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
LogicalId() *string
// The tree node.
Node() constructs.Node
// 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 })`.
Ref() *string
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// 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.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// 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.
//
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` 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,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` 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.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
// 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`).
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
// 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.
GetAtt(attributeName *string) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// 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.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::Greengrass::CoreDefinitionVersion`.
The `AWS::Greengrass::CoreDefinitionVersion` resource represents a core definition version for AWS IoT Greengrass . A core definition version contains a Greengrass core.
> To create a core definition version, you must specify the ID of the core definition that you want to associate with the version. For information about creating a core definition, see [`AWS::Greengrass::CoreDefinition`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-coredefinition.html) . > > After you create a core definition version that contains the core you want to deploy, you must add it to your group version. For more information, see [`AWS::Greengrass::Group`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html) .
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import greengrass "github.com/aws/aws-cdk-go/awscdk/aws_greengrass"
cfnCoreDefinitionVersion := greengrass.NewCfnCoreDefinitionVersion(this, jsii.String("MyCfnCoreDefinitionVersion"), &cfnCoreDefinitionVersionProps{
coreDefinitionId: jsii.String("coreDefinitionId"),
cores: []interface{}{
&coreProperty{
certificateArn: jsii.String("certificateArn"),
id: jsii.String("id"),
thingArn: jsii.String("thingArn"),
// the properties below are optional
syncShadow: jsii.Boolean(false),
},
},
})
func NewCfnCoreDefinitionVersion ¶
func NewCfnCoreDefinitionVersion(scope constructs.Construct, id *string, props *CfnCoreDefinitionVersionProps) CfnCoreDefinitionVersion
Create a new `AWS::Greengrass::CoreDefinitionVersion`.
type CfnCoreDefinitionVersionProps ¶
type CfnCoreDefinitionVersionProps struct {
// The ID of the core definition associated with this version.
//
// This value is a GUID.
CoreDefinitionId *string `json:"coreDefinitionId" yaml:"coreDefinitionId"`
// The Greengrass core in this version.
//
// Currently, the `Cores` property for a core definition version can contain only one core.
Cores interface{} `json:"cores" yaml:"cores"`
}
Properties for defining a `CfnCoreDefinitionVersion`.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import greengrass "github.com/aws/aws-cdk-go/awscdk/aws_greengrass"
cfnCoreDefinitionVersionProps := &cfnCoreDefinitionVersionProps{
coreDefinitionId: jsii.String("coreDefinitionId"),
cores: []interface{}{
&coreProperty{
certificateArn: jsii.String("certificateArn"),
id: jsii.String("id"),
thingArn: jsii.String("thingArn"),
// the properties below are optional
syncShadow: jsii.Boolean(false),
},
},
}
type CfnCoreDefinitionVersion_CoreProperty ¶
type CfnCoreDefinitionVersion_CoreProperty struct {
// The ARN of the device certificate for the core.
//
// This X.509 certificate is used to authenticate the core with AWS IoT and AWS IoT Greengrass services.
CertificateArn *string `json:"certificateArn" yaml:"certificateArn"`
// A descriptive or arbitrary ID for the core.
//
// This value must be unique within the core definition version. Maximum length is 128 characters with pattern `[a-zA-Z0-9:_-]+` .
Id *string `json:"id" yaml:"id"`
// The Amazon Resource Name (ARN) of the core, which is an AWS IoT device (thing).
ThingArn *string `json:"thingArn" yaml:"thingArn"`
// Indicates whether the core's local shadow is synced with the cloud automatically.
//
// The default is false.
SyncShadow interface{} `json:"syncShadow" yaml:"syncShadow"`
}
A core is an AWS IoT device that runs the AWS IoT Greengrass core software and manages local processes for a Greengrass group.
For more information, see [What Is AWS IoT Greengrass ?](https://docs.aws.amazon.com/greengrass/latest/developerguide/what-is-gg.html) in the *Developer Guide* .
In an AWS CloudFormation template, the `Cores` property of the [`AWS::Greengrass::CoreDefinitionVersion`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-coredefinitionversion.html) resource contains a list of `Core` property types. Currently, the list can contain only one core.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import greengrass "github.com/aws/aws-cdk-go/awscdk/aws_greengrass"
coreProperty := &coreProperty{
certificateArn: jsii.String("certificateArn"),
id: jsii.String("id"),
thingArn: jsii.String("thingArn"),
// the properties below are optional
syncShadow: jsii.Boolean(false),
}
type CfnCoreDefinition_CoreDefinitionVersionProperty ¶
type CfnCoreDefinition_CoreDefinitionVersionProperty struct {
// The Greengrass core in this version.
//
// Currently, the `Cores` property for a core definition version can contain only one core.
Cores interface{} `json:"cores" yaml:"cores"`
}
A core definition version contains a Greengrass [core](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-coredefinition-core.html) .
> After you create a core definition version that contains the core you want to deploy, you must add it to your group version. For more information, see [`AWS::Greengrass::Group`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html) .
In an AWS CloudFormation template, `CoreDefinitionVersion` is the property type of the `InitialVersion` property in the [`AWS::Greengrass::CoreDefinition`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-coredefinition.html) resource.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import greengrass "github.com/aws/aws-cdk-go/awscdk/aws_greengrass"
coreDefinitionVersionProperty := &coreDefinitionVersionProperty{
cores: []interface{}{
&coreProperty{
certificateArn: jsii.String("certificateArn"),
id: jsii.String("id"),
thingArn: jsii.String("thingArn"),
// the properties below are optional
syncShadow: jsii.Boolean(false),
},
},
}
type CfnCoreDefinition_CoreProperty ¶
type CfnCoreDefinition_CoreProperty struct {
// The Amazon Resource Name (ARN) of the device certificate for the core.
//
// This X.509 certificate is used to authenticate the core with AWS IoT and AWS IoT Greengrass services.
CertificateArn *string `json:"certificateArn" yaml:"certificateArn"`
// A descriptive or arbitrary ID for the core.
//
// This value must be unique within the core definition version. Maximum length is 128 characters with pattern `[a-zA-Z0-9:_-]+` .
Id *string `json:"id" yaml:"id"`
// The ARN of the core, which is an AWS IoT device (thing).
ThingArn *string `json:"thingArn" yaml:"thingArn"`
// Indicates whether the core's local shadow is synced with the cloud automatically.
//
// The default is false.
SyncShadow interface{} `json:"syncShadow" yaml:"syncShadow"`
}
A core is an AWS IoT device that runs the AWS IoT Greengrass core software and manages local processes for a Greengrass group.
For more information, see [What Is AWS IoT Greengrass ?](https://docs.aws.amazon.com/greengrass/latest/developerguide/what-is-gg.html) in the *Developer Guide* .
In an AWS CloudFormation template, the `Cores` property of the [`CoreDefinitionVersion`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-coredefinition-coredefinitionversion.html) property type contains a list of `Core` property types. Currently, the list can contain only one core.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import greengrass "github.com/aws/aws-cdk-go/awscdk/aws_greengrass"
coreProperty := &coreProperty{
certificateArn: jsii.String("certificateArn"),
id: jsii.String("id"),
thingArn: jsii.String("thingArn"),
// the properties below are optional
syncShadow: jsii.Boolean(false),
}
type CfnDeviceDefinition ¶
type CfnDeviceDefinition interface {
awscdk.CfnResource
awscdk.IInspectable
// The Amazon Resource Name (ARN) of the `DeviceDefinition` , such as `arn:aws:greengrass:us-east-1: :/greengrass/definition/devices/1234a5b6-78cd-901e-2fgh-3i45j6k178l9` .
AttrArn() *string
// The ID of the `DeviceDefinition` , such as `1234a5b6-78cd-901e-2fgh-3i45j6k178l9` .
AttrId() *string
// The ARN of the last `DeviceDefinitionVersion` that was added to the `DeviceDefinition` , such as `arn:aws:greengrass:us-east-1: :/greengrass/definition/devices/1234a5b6-78cd-901e-2fgh-3i45j6k178l9/versions/9876ac30-4bdb-4f9d-95af-b5fdb66be1a2` .
AttrLatestVersionArn() *string
// The name of the device definition.
AttrName() *string
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
// Returns: 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.
CreationStack() *[]*string
// The device definition version to include when the device definition is created.
//
// A device definition version contains a list of [`device`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-devicedefinition-device.html) property types.
//
// > To associate a device definition version after the device definition is created, create an [`AWS::Greengrass::DeviceDefinitionVersion`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-devicedefinitionversion.html) resource and specify the ID of this device definition.
InitialVersion() interface{}
SetInitialVersion(val interface{})
// 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)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
LogicalId() *string
// The name of the device definition.
Name() *string
SetName(val *string)
// The tree node.
Node() constructs.Node
// 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 })`.
Ref() *string
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// Application-specific metadata to attach to the device definition.
//
// You can use tags in IAM policies to control access to AWS IoT Greengrass resources. You can also use tags to categorize your resources. For more information, see [Tagging Your AWS IoT Greengrass Resources](https://docs.aws.amazon.com/greengrass/latest/developerguide/tagging.html) in the *Developer Guide* .
//
// This `Json` property type is processed as a map of key-value pairs. It uses the following format, which is different from most `Tags` implementations in AWS CloudFormation templates.
//
// “`json
// "Tags": { "KeyName0": "value", "KeyName1": "value", "KeyName2": "value"
// }
// “`.
Tags() awscdk.TagManager
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// 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.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// 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.
//
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` 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,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` 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.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
// 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`).
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
// 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.
GetAtt(attributeName *string) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// 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.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::Greengrass::DeviceDefinition`.
The `AWS::Greengrass::DeviceDefinition` resource represents a device definition for AWS IoT Greengrass . Device definitions are used to organize your device definition versions.
Device definitions can reference multiple device definition versions. All device definition versions must be associated with a device definition. Each device definition version can contain one or more devices.
> When you create a device definition, you can optionally include an initial device definition version. To associate a device definition version later, create an [`AWS::Greengrass::DeviceDefinitionVersion`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-devicedefinitionversion.html) resource and specify the ID of this device definition. > > After you create the device definition version that contains the devices you want to deploy, you must add it to your group version. For more information, see [`AWS::Greengrass::Group`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html) .
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import greengrass "github.com/aws/aws-cdk-go/awscdk/aws_greengrass"
var tags interface{}
cfnDeviceDefinition := greengrass.NewCfnDeviceDefinition(this, jsii.String("MyCfnDeviceDefinition"), &cfnDeviceDefinitionProps{
name: jsii.String("name"),
// the properties below are optional
initialVersion: &deviceDefinitionVersionProperty{
devices: []interface{}{
&deviceProperty{
certificateArn: jsii.String("certificateArn"),
id: jsii.String("id"),
thingArn: jsii.String("thingArn"),
// the properties below are optional
syncShadow: jsii.Boolean(false),
},
},
},
tags: tags,
})
func NewCfnDeviceDefinition ¶
func NewCfnDeviceDefinition(scope constructs.Construct, id *string, props *CfnDeviceDefinitionProps) CfnDeviceDefinition
Create a new `AWS::Greengrass::DeviceDefinition`.
type CfnDeviceDefinitionProps ¶
type CfnDeviceDefinitionProps struct {
// The name of the device definition.
Name *string `json:"name" yaml:"name"`
// The device definition version to include when the device definition is created.
//
// A device definition version contains a list of [`device`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-devicedefinition-device.html) property types.
//
// > To associate a device definition version after the device definition is created, create an [`AWS::Greengrass::DeviceDefinitionVersion`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-devicedefinitionversion.html) resource and specify the ID of this device definition.
InitialVersion interface{} `json:"initialVersion" yaml:"initialVersion"`
// Application-specific metadata to attach to the device definition.
//
// You can use tags in IAM policies to control access to AWS IoT Greengrass resources. You can also use tags to categorize your resources. For more information, see [Tagging Your AWS IoT Greengrass Resources](https://docs.aws.amazon.com/greengrass/latest/developerguide/tagging.html) in the *Developer Guide* .
//
// This `Json` property type is processed as a map of key-value pairs. It uses the following format, which is different from most `Tags` implementations in AWS CloudFormation templates.
//
// “`json
// "Tags": { "KeyName0": "value", "KeyName1": "value", "KeyName2": "value"
// }
// “`.
Tags interface{} `json:"tags" yaml:"tags"`
}
Properties for defining a `CfnDeviceDefinition`.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import greengrass "github.com/aws/aws-cdk-go/awscdk/aws_greengrass"
var tags interface{}
cfnDeviceDefinitionProps := &cfnDeviceDefinitionProps{
name: jsii.String("name"),
// the properties below are optional
initialVersion: &deviceDefinitionVersionProperty{
devices: []interface{}{
&deviceProperty{
certificateArn: jsii.String("certificateArn"),
id: jsii.String("id"),
thingArn: jsii.String("thingArn"),
// the properties below are optional
syncShadow: jsii.Boolean(false),
},
},
},
tags: tags,
}
type CfnDeviceDefinitionVersion ¶
type CfnDeviceDefinitionVersion interface {
awscdk.CfnResource
awscdk.IInspectable
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
// Returns: 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.
CreationStack() *[]*string
// The ID of the device definition associated with this version.
//
// This value is a GUID.
DeviceDefinitionId() *string
SetDeviceDefinitionId(val *string)
// The devices in this version.
Devices() interface{}
SetDevices(val interface{})
// 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)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
LogicalId() *string
// The tree node.
Node() constructs.Node
// 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 })`.
Ref() *string
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// 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.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// 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.
//
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` 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,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` 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.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
// 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`).
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
// 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.
GetAtt(attributeName *string) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// 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.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::Greengrass::DeviceDefinitionVersion`.
The `AWS::Greengrass::DeviceDefinitionVersion` resource represents a device definition version for AWS IoT Greengrass . A device definition version contains a list of devices.
> To create a device definition version, you must specify the ID of the device definition that you want to associate with the version. For information about creating a device definition, see [`AWS::Greengrass::DeviceDefinition`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-devicedefinition.html) . > > After you create a device definition version that contains the devices you want to deploy, you must add it to your group version. For more information, see [`AWS::Greengrass::Group`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html) .
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import greengrass "github.com/aws/aws-cdk-go/awscdk/aws_greengrass"
cfnDeviceDefinitionVersion := greengrass.NewCfnDeviceDefinitionVersion(this, jsii.String("MyCfnDeviceDefinitionVersion"), &cfnDeviceDefinitionVersionProps{
deviceDefinitionId: jsii.String("deviceDefinitionId"),
devices: []interface{}{
&deviceProperty{
certificateArn: jsii.String("certificateArn"),
id: jsii.String("id"),
thingArn: jsii.String("thingArn"),
// the properties below are optional
syncShadow: jsii.Boolean(false),
},
},
})
func NewCfnDeviceDefinitionVersion ¶
func NewCfnDeviceDefinitionVersion(scope constructs.Construct, id *string, props *CfnDeviceDefinitionVersionProps) CfnDeviceDefinitionVersion
Create a new `AWS::Greengrass::DeviceDefinitionVersion`.
type CfnDeviceDefinitionVersionProps ¶
type CfnDeviceDefinitionVersionProps struct {
// The ID of the device definition associated with this version.
//
// This value is a GUID.
DeviceDefinitionId *string `json:"deviceDefinitionId" yaml:"deviceDefinitionId"`
// The devices in this version.
Devices interface{} `json:"devices" yaml:"devices"`
}
Properties for defining a `CfnDeviceDefinitionVersion`.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import greengrass "github.com/aws/aws-cdk-go/awscdk/aws_greengrass"
cfnDeviceDefinitionVersionProps := &cfnDeviceDefinitionVersionProps{
deviceDefinitionId: jsii.String("deviceDefinitionId"),
devices: []interface{}{
&deviceProperty{
certificateArn: jsii.String("certificateArn"),
id: jsii.String("id"),
thingArn: jsii.String("thingArn"),
// the properties below are optional
syncShadow: jsii.Boolean(false),
},
},
}
type CfnDeviceDefinitionVersion_DeviceProperty ¶
type CfnDeviceDefinitionVersion_DeviceProperty struct {
// The ARN of the device certificate for the device.
//
// This X.509 certificate is used to authenticate the device with AWS IoT and AWS IoT Greengrass services.
CertificateArn *string `json:"certificateArn" yaml:"certificateArn"`
// A descriptive or arbitrary ID for the device.
//
// This value must be unique within the device definition version. Maximum length is 128 characters with pattern `[a-zA-Z0-9:_-]+` .
Id *string `json:"id" yaml:"id"`
// The Amazon Resource Name (ARN) of the device, which is an AWS IoT device (thing).
ThingArn *string `json:"thingArn" yaml:"thingArn"`
// Indicates whether the device's local shadow is synced with the cloud automatically.
SyncShadow interface{} `json:"syncShadow" yaml:"syncShadow"`
}
A device is an AWS IoT device (thing) that's added to a Greengrass group.
Greengrass devices can communicate with the Greengrass core in the same group. For more information, see [What Is AWS IoT Greengrass ?](https://docs.aws.amazon.com/greengrass/latest/developerguide/what-is-gg.html) in the *Developer Guide* .
In an AWS CloudFormation template, the `Devices` property of the [`AWS::Greengrass::DeviceDefinitionVersion`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-devicedefinitionversion.html) resource contains a list of `Device` property types.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import greengrass "github.com/aws/aws-cdk-go/awscdk/aws_greengrass"
deviceProperty := &deviceProperty{
certificateArn: jsii.String("certificateArn"),
id: jsii.String("id"),
thingArn: jsii.String("thingArn"),
// the properties below are optional
syncShadow: jsii.Boolean(false),
}
type CfnDeviceDefinition_DeviceDefinitionVersionProperty ¶
type CfnDeviceDefinition_DeviceDefinitionVersionProperty struct {
// The devices in this version.
Devices interface{} `json:"devices" yaml:"devices"`
}
A device definition version contains a list of [devices](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-devicedefinition-device.html) .
> After you create a device definition version that contains the devices you want to deploy, you must add it to your group version. For more information, see [`AWS::Greengrass::Group`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html) .
In an AWS CloudFormation template, `DeviceDefinitionVersion` is the property type of the `InitialVersion` property in the [`AWS::Greengrass::DeviceDefinition`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-devicedefinition.html) resource.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import greengrass "github.com/aws/aws-cdk-go/awscdk/aws_greengrass"
deviceDefinitionVersionProperty := &deviceDefinitionVersionProperty{
devices: []interface{}{
&deviceProperty{
certificateArn: jsii.String("certificateArn"),
id: jsii.String("id"),
thingArn: jsii.String("thingArn"),
// the properties below are optional
syncShadow: jsii.Boolean(false),
},
},
}
type CfnDeviceDefinition_DeviceProperty ¶
type CfnDeviceDefinition_DeviceProperty struct {
// The Amazon Resource Name (ARN) of the device certificate for the device.
//
// This X.509 certificate is used to authenticate the device with AWS IoT and AWS IoT Greengrass services.
CertificateArn *string `json:"certificateArn" yaml:"certificateArn"`
// A descriptive or arbitrary ID for the device.
//
// This value must be unique within the device definition version. Maximum length is 128 characters with pattern `[a-zA-Z0-9:_-]+` .
Id *string `json:"id" yaml:"id"`
// The ARN of the device, which is an AWS IoT device (thing).
ThingArn *string `json:"thingArn" yaml:"thingArn"`
// Indicates whether the device's local shadow is synced with the cloud automatically.
SyncShadow interface{} `json:"syncShadow" yaml:"syncShadow"`
}
A device is an AWS IoT device (thing) that's added to a Greengrass group.
Greengrass devices can communicate with the Greengrass core in the same group. For more information, see [What Is AWS IoT Greengrass ?](https://docs.aws.amazon.com/greengrass/latest/developerguide/what-is-gg.html) in the *Developer Guide* .
In an AWS CloudFormation template, the `Devices` property of the [`DeviceDefinitionVersion`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-devicedefinition-devicedefinitionversion.html) property type contains a list of `Device` property types.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import greengrass "github.com/aws/aws-cdk-go/awscdk/aws_greengrass"
deviceProperty := &deviceProperty{
certificateArn: jsii.String("certificateArn"),
id: jsii.String("id"),
thingArn: jsii.String("thingArn"),
// the properties below are optional
syncShadow: jsii.Boolean(false),
}
type CfnFunctionDefinition ¶
type CfnFunctionDefinition interface {
awscdk.CfnResource
awscdk.IInspectable
// The Amazon Resource Name (ARN) of the `FunctionDefinition` , such as `arn:aws:greengrass:us-east-1: :/greengrass/definition/functions/1234a5b6-78cd-901e-2fgh-3i45j6k178l9` .
AttrArn() *string
// The ID of the `FunctionDefinition` , such as `1234a5b6-78cd-901e-2fgh-3i45j6k178l9` .
AttrId() *string
// The ARN of the last `FunctionDefinitionVersion` that was added to the `FunctionDefinition` , such as `arn:aws:greengrass:us-east-1: :/greengrass/definition/functions/1234a5b6-78cd-901e-2fgh-3i45j6k178l9/versions/9876ac30-4bdb-4f9d-95af-b5fdb66be1a2` .
AttrLatestVersionArn() *string
// The name of the `FunctionDefinition` , such as `MyFunctionDefinition` .
AttrName() *string
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
// Returns: 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.
CreationStack() *[]*string
// The function definition version to include when the function definition is created.
//
// A function definition version contains a list of [`function`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-function.html) property types.
//
// > To associate a function definition version after the function definition is created, create an [`AWS::Greengrass::FunctionDefinitionVersion`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-functiondefinitionversion.html) resource and specify the ID of this function definition.
InitialVersion() interface{}
SetInitialVersion(val interface{})
// 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)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
LogicalId() *string
// The name of the function definition.
Name() *string
SetName(val *string)
// The tree node.
Node() constructs.Node
// 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 })`.
Ref() *string
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// Application-specific metadata to attach to the function definition.
//
// You can use tags in IAM policies to control access to AWS IoT Greengrass resources. You can also use tags to categorize your resources. For more information, see [Tagging Your AWS IoT Greengrass Resources](https://docs.aws.amazon.com/greengrass/latest/developerguide/tagging.html) in the *Developer Guide* .
//
// This `Json` property type is processed as a map of key-value pairs. It uses the following format, which is different from most `Tags` implementations in AWS CloudFormation templates.
//
// “`json
// "Tags": { "KeyName0": "value", "KeyName1": "value", "KeyName2": "value"
// }
// “`.
Tags() awscdk.TagManager
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// 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.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// 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.
//
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` 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,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` 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.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
// 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`).
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
// 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.
GetAtt(attributeName *string) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// 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.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::Greengrass::FunctionDefinition`.
The `AWS::Greengrass::FunctionDefinition` resource represents a function definition for AWS IoT Greengrass . Function definitions are used to organize your function definition versions.
Function definitions can reference multiple function definition versions. All function definition versions must be associated with a function definition. Each function definition version can contain one or more functions.
> When you create a function definition, you can optionally include an initial function definition version. To associate a function definition version later, create an [`AWS::Greengrass::FunctionDefinitionVersion`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-functiondefinitionversion.html) resource and specify the ID of this function definition. > > After you create the function definition version that contains the functions you want to deploy, you must add it to your group version. For more information, see [`AWS::Greengrass::Group`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html) .
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import greengrass "github.com/aws/aws-cdk-go/awscdk/aws_greengrass"
var tags interface{}
var variables interface{}
cfnFunctionDefinition := greengrass.NewCfnFunctionDefinition(this, jsii.String("MyCfnFunctionDefinition"), &cfnFunctionDefinitionProps{
name: jsii.String("name"),
// the properties below are optional
initialVersion: &functionDefinitionVersionProperty{
functions: []interface{}{
&functionProperty{
functionArn: jsii.String("functionArn"),
functionConfiguration: &functionConfigurationProperty{
encodingType: jsii.String("encodingType"),
environment: &environmentProperty{
accessSysfs: jsii.Boolean(false),
execution: &executionProperty{
isolationMode: jsii.String("isolationMode"),
runAs: &runAsProperty{
gid: jsii.Number(123),
uid: jsii.Number(123),
},
},
resourceAccessPolicies: []interface{}{
&resourceAccessPolicyProperty{
resourceId: jsii.String("resourceId"),
// the properties below are optional
permission: jsii.String("permission"),
},
},
variables: variables,
},
execArgs: jsii.String("execArgs"),
executable: jsii.String("executable"),
memorySize: jsii.Number(123),
pinned: jsii.Boolean(false),
timeout: jsii.Number(123),
},
id: jsii.String("id"),
},
},
// the properties below are optional
defaultConfig: &defaultConfigProperty{
execution: &executionProperty{
isolationMode: jsii.String("isolationMode"),
runAs: &runAsProperty{
gid: jsii.Number(123),
uid: jsii.Number(123),
},
},
},
},
tags: tags,
})
func NewCfnFunctionDefinition ¶
func NewCfnFunctionDefinition(scope constructs.Construct, id *string, props *CfnFunctionDefinitionProps) CfnFunctionDefinition
Create a new `AWS::Greengrass::FunctionDefinition`.
type CfnFunctionDefinitionProps ¶
type CfnFunctionDefinitionProps struct {
// The name of the function definition.
Name *string `json:"name" yaml:"name"`
// The function definition version to include when the function definition is created.
//
// A function definition version contains a list of [`function`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-function.html) property types.
//
// > To associate a function definition version after the function definition is created, create an [`AWS::Greengrass::FunctionDefinitionVersion`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-functiondefinitionversion.html) resource and specify the ID of this function definition.
InitialVersion interface{} `json:"initialVersion" yaml:"initialVersion"`
// Application-specific metadata to attach to the function definition.
//
// You can use tags in IAM policies to control access to AWS IoT Greengrass resources. You can also use tags to categorize your resources. For more information, see [Tagging Your AWS IoT Greengrass Resources](https://docs.aws.amazon.com/greengrass/latest/developerguide/tagging.html) in the *Developer Guide* .
//
// This `Json` property type is processed as a map of key-value pairs. It uses the following format, which is different from most `Tags` implementations in AWS CloudFormation templates.
//
// “`json
// "Tags": { "KeyName0": "value", "KeyName1": "value", "KeyName2": "value"
// }
// “`.
Tags interface{} `json:"tags" yaml:"tags"`
}
Properties for defining a `CfnFunctionDefinition`.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import greengrass "github.com/aws/aws-cdk-go/awscdk/aws_greengrass"
var tags interface{}
var variables interface{}
cfnFunctionDefinitionProps := &cfnFunctionDefinitionProps{
name: jsii.String("name"),
// the properties below are optional
initialVersion: &functionDefinitionVersionProperty{
functions: []interface{}{
&functionProperty{
functionArn: jsii.String("functionArn"),
functionConfiguration: &functionConfigurationProperty{
encodingType: jsii.String("encodingType"),
environment: &environmentProperty{
accessSysfs: jsii.Boolean(false),
execution: &executionProperty{
isolationMode: jsii.String("isolationMode"),
runAs: &runAsProperty{
gid: jsii.Number(123),
uid: jsii.Number(123),
},
},
resourceAccessPolicies: []interface{}{
&resourceAccessPolicyProperty{
resourceId: jsii.String("resourceId"),
// the properties below are optional
permission: jsii.String("permission"),
},
},
variables: variables,
},
execArgs: jsii.String("execArgs"),
executable: jsii.String("executable"),
memorySize: jsii.Number(123),
pinned: jsii.Boolean(false),
timeout: jsii.Number(123),
},
id: jsii.String("id"),
},
},
// the properties below are optional
defaultConfig: &defaultConfigProperty{
execution: &executionProperty{
isolationMode: jsii.String("isolationMode"),
runAs: &runAsProperty{
gid: jsii.Number(123),
uid: jsii.Number(123),
},
},
},
},
tags: tags,
}
type CfnFunctionDefinitionVersion ¶
type CfnFunctionDefinitionVersion interface {
awscdk.CfnResource
awscdk.IInspectable
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
// Returns: 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.
CreationStack() *[]*string
// The default configuration that applies to all Lambda functions in the group.
//
// Individual Lambda functions can override these settings.
DefaultConfig() interface{}
SetDefaultConfig(val interface{})
// The ID of the function definition associated with this version.
//
// This value is a GUID.
FunctionDefinitionId() *string
SetFunctionDefinitionId(val *string)
// The functions in this version.
Functions() interface{}
SetFunctions(val interface{})
// 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)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
LogicalId() *string
// The tree node.
Node() constructs.Node
// 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 })`.
Ref() *string
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// 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.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// 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.
//
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` 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,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` 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.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
// 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`).
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
// 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.
GetAtt(attributeName *string) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// 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.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::Greengrass::FunctionDefinitionVersion`.
The `AWS::Greengrass::FunctionDefinitionVersion` resource represents a function definition version for AWS IoT Greengrass . A function definition version contains contain a list of functions.
> To create a function definition version, you must specify the ID of the function definition that you want to associate with the version. For information about creating a function definition, see [`AWS::Greengrass::FunctionDefinition`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-functiondefinition.html) . > > After you create a function definition version that contains the functions you want to deploy, you must add it to your group version. For more information, see [`AWS::Greengrass::Group`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html) .
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import greengrass "github.com/aws/aws-cdk-go/awscdk/aws_greengrass"
var variables interface{}
cfnFunctionDefinitionVersion := greengrass.NewCfnFunctionDefinitionVersion(this, jsii.String("MyCfnFunctionDefinitionVersion"), &cfnFunctionDefinitionVersionProps{
functionDefinitionId: jsii.String("functionDefinitionId"),
functions: []interface{}{
&functionProperty{
functionArn: jsii.String("functionArn"),
functionConfiguration: &functionConfigurationProperty{
encodingType: jsii.String("encodingType"),
environment: &environmentProperty{
accessSysfs: jsii.Boolean(false),
execution: &executionProperty{
isolationMode: jsii.String("isolationMode"),
runAs: &runAsProperty{
gid: jsii.Number(123),
uid: jsii.Number(123),
},
},
resourceAccessPolicies: []interface{}{
&resourceAccessPolicyProperty{
resourceId: jsii.String("resourceId"),
// the properties below are optional
permission: jsii.String("permission"),
},
},
variables: variables,
},
execArgs: jsii.String("execArgs"),
executable: jsii.String("executable"),
memorySize: jsii.Number(123),
pinned: jsii.Boolean(false),
timeout: jsii.Number(123),
},
id: jsii.String("id"),
},
},
// the properties below are optional
defaultConfig: &defaultConfigProperty{
execution: &executionProperty{
isolationMode: jsii.String("isolationMode"),
runAs: &runAsProperty{
gid: jsii.Number(123),
uid: jsii.Number(123),
},
},
},
})
func NewCfnFunctionDefinitionVersion ¶
func NewCfnFunctionDefinitionVersion(scope constructs.Construct, id *string, props *CfnFunctionDefinitionVersionProps) CfnFunctionDefinitionVersion
Create a new `AWS::Greengrass::FunctionDefinitionVersion`.
type CfnFunctionDefinitionVersionProps ¶
type CfnFunctionDefinitionVersionProps struct {
// The ID of the function definition associated with this version.
//
// This value is a GUID.
FunctionDefinitionId *string `json:"functionDefinitionId" yaml:"functionDefinitionId"`
// The functions in this version.
Functions interface{} `json:"functions" yaml:"functions"`
// The default configuration that applies to all Lambda functions in the group.
//
// Individual Lambda functions can override these settings.
DefaultConfig interface{} `json:"defaultConfig" yaml:"defaultConfig"`
}
Properties for defining a `CfnFunctionDefinitionVersion`.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import greengrass "github.com/aws/aws-cdk-go/awscdk/aws_greengrass"
var variables interface{}
cfnFunctionDefinitionVersionProps := &cfnFunctionDefinitionVersionProps{
functionDefinitionId: jsii.String("functionDefinitionId"),
functions: []interface{}{
&functionProperty{
functionArn: jsii.String("functionArn"),
functionConfiguration: &functionConfigurationProperty{
encodingType: jsii.String("encodingType"),
environment: &environmentProperty{
accessSysfs: jsii.Boolean(false),
execution: &executionProperty{
isolationMode: jsii.String("isolationMode"),
runAs: &runAsProperty{
gid: jsii.Number(123),
uid: jsii.Number(123),
},
},
resourceAccessPolicies: []interface{}{
&resourceAccessPolicyProperty{
resourceId: jsii.String("resourceId"),
// the properties below are optional
permission: jsii.String("permission"),
},
},
variables: variables,
},
execArgs: jsii.String("execArgs"),
executable: jsii.String("executable"),
memorySize: jsii.Number(123),
pinned: jsii.Boolean(false),
timeout: jsii.Number(123),
},
id: jsii.String("id"),
},
},
// the properties below are optional
defaultConfig: &defaultConfigProperty{
execution: &executionProperty{
isolationMode: jsii.String("isolationMode"),
runAs: &runAsProperty{
gid: jsii.Number(123),
uid: jsii.Number(123),
},
},
},
}
type CfnFunctionDefinitionVersion_DefaultConfigProperty ¶
type CfnFunctionDefinitionVersion_DefaultConfigProperty struct {
// Configuration settings for the Lambda execution environment on the AWS IoT Greengrass core.
Execution interface{} `json:"execution" yaml:"execution"`
}
The default configuration that applies to all Lambda functions in the function definition version.
Individual Lambda functions can override these settings.
In an AWS CloudFormation template, `DefaultConfig` is a property of the [`AWS::Greengrass::FunctionDefinitionVersion`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-functiondefinitionversion.html) resource.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import greengrass "github.com/aws/aws-cdk-go/awscdk/aws_greengrass"
defaultConfigProperty := &defaultConfigProperty{
execution: &executionProperty{
isolationMode: jsii.String("isolationMode"),
runAs: &runAsProperty{
gid: jsii.Number(123),
uid: jsii.Number(123),
},
},
}
type CfnFunctionDefinitionVersion_EnvironmentProperty ¶
type CfnFunctionDefinitionVersion_EnvironmentProperty struct {
// Indicates whether the function is allowed to access the `/sys` directory on the core device, which allows the read device information from `/sys` .
//
// > This property applies only to Lambda functions that run in a Greengrass container.
AccessSysfs interface{} `json:"accessSysfs" yaml:"accessSysfs"`
// Settings for the Lambda execution environment in AWS IoT Greengrass .
Execution interface{} `json:"execution" yaml:"execution"`
// A list of the [resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-resourceinstance.html) in the group that the function can access, with the corresponding read-only or read-write permissions. The maximum is 10 resources.
//
// > This property applies only to Lambda functions that run in a Greengrass container.
ResourceAccessPolicies interface{} `json:"resourceAccessPolicies" yaml:"resourceAccessPolicies"`
// Environment variables for the Lambda function.
Variables interface{} `json:"variables" yaml:"variables"`
}
The environment configuration for a Lambda function on the AWS IoT Greengrass core.
In an AWS CloudFormation template, `Environment` is a property of the [`FunctionConfiguration`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-functionconfiguration.html) property type.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import greengrass "github.com/aws/aws-cdk-go/awscdk/aws_greengrass"
var variables interface{}
environmentProperty := &environmentProperty{
accessSysfs: jsii.Boolean(false),
execution: &executionProperty{
isolationMode: jsii.String("isolationMode"),
runAs: &runAsProperty{
gid: jsii.Number(123),
uid: jsii.Number(123),
},
},
resourceAccessPolicies: []interface{}{
&resourceAccessPolicyProperty{
resourceId: jsii.String("resourceId"),
// the properties below are optional
permission: jsii.String("permission"),
},
},
variables: variables,
}
type CfnFunctionDefinitionVersion_ExecutionProperty ¶
type CfnFunctionDefinitionVersion_ExecutionProperty struct {
// The containerization that the Lambda function runs in.
//
// Valid values are `GreengrassContainer` or `NoContainer` . Typically, this is `GreengrassContainer` . For more information, see [Containerization](https://docs.aws.amazon.com/greengrass/latest/developerguide/lambda-group-config.html#lambda-function-containerization) in the *Developer Guide* .
//
// - When set on the [`DefaultConfig`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-defaultconfig.html) property of a function definition version, this setting is used as the default containerization for all Lambda functions in the function definition version.
// - When set on the [`Environment`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-environment.html) property of a function, this setting applies to the individual function and overrides the default. Omit this value to run the function with the default containerization.
//
// > We recommend that you run in a Greengrass container unless your business case requires that you run without containerization.
IsolationMode *string `json:"isolationMode" yaml:"isolationMode"`
// The user and group permissions used to run the Lambda function.
//
// Typically, this is the ggc_user and ggc_group. For more information, see [Run as](https://docs.aws.amazon.com/greengrass/latest/developerguide/lambda-group-config.html#lambda-access-identity.html) in the *Developer Guide* .
//
// - When set on the [`DefaultConfig`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-defaultconfig.html) property of a function definition version, this setting is used as the default access identity for all Lambda functions in the function definition version.
// - When set on the [`Environment`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-environment.html) property of a function, this setting applies to the individual function and overrides the default. You can override the user, group, or both. Omit this value to run the function with the default permissions.
//
// > Running as the root user increases risks to your data and device. Do not run as root (UID/GID=0) unless your business case requires it. For more information and requirements, see [Running a Lambda Function as Root](https://docs.aws.amazon.com/greengrass/latest/developerguide/lambda-group-config.html#lambda-running-as-root) .
RunAs interface{} `json:"runAs" yaml:"runAs"`
}
Configuration settings for the Lambda execution environment on the AWS IoT Greengrass core.
In an AWS CloudFormation template, `Execution` is a property of the [`DefaultConfig`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-defaultconfig.html) property type for a function definition version and the [`Environment`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-environment.html) property type for a function.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import greengrass "github.com/aws/aws-cdk-go/awscdk/aws_greengrass"
executionProperty := &executionProperty{
isolationMode: jsii.String("isolationMode"),
runAs: &runAsProperty{
gid: jsii.Number(123),
uid: jsii.Number(123),
},
}
type CfnFunctionDefinitionVersion_FunctionConfigurationProperty ¶
type CfnFunctionDefinitionVersion_FunctionConfigurationProperty struct {
// The expected encoding type of the input payload for the function.
//
// Valid values are `json` (default) and `binary` .
EncodingType *string `json:"encodingType" yaml:"encodingType"`
// The environment configuration of the function.
Environment interface{} `json:"environment" yaml:"environment"`
// The execution arguments.
ExecArgs *string `json:"execArgs" yaml:"execArgs"`
// The name of the function executable.
Executable *string `json:"executable" yaml:"executable"`
// The memory size (in KB) required by the function.
//
// > This property applies only to Lambda functions that run in a Greengrass container.
MemorySize *float64 `json:"memorySize" yaml:"memorySize"`
// Indicates whether the function is pinned (or *long-lived* ).
//
// Pinned functions start when the core starts and process all requests in the same container. The default value is false.
Pinned interface{} `json:"pinned" yaml:"pinned"`
// The allowed execution time (in seconds) after which the function should terminate.
//
// For pinned functions, this timeout applies for each request.
Timeout *float64 `json:"timeout" yaml:"timeout"`
}
The group-specific configuration settings for a Lambda function.
These settings configure the function's behavior in the Greengrass group. For more information, see [Controlling Execution of Greengrass Lambda Functions by Using Group-Specific Configuration](https://docs.aws.amazon.com/greengrass/latest/developerguide/lambda-group-config.html) in the *Developer Guide* .
In an AWS CloudFormation template, `FunctionConfiguration` is a property of the [`Function`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-function.html) property type.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import greengrass "github.com/aws/aws-cdk-go/awscdk/aws_greengrass"
var variables interface{}
functionConfigurationProperty := &functionConfigurationProperty{
encodingType: jsii.String("encodingType"),
environment: &environmentProperty{
accessSysfs: jsii.Boolean(false),
execution: &executionProperty{
isolationMode: jsii.String("isolationMode"),
runAs: &runAsProperty{
gid: jsii.Number(123),
uid: jsii.Number(123),
},
},
resourceAccessPolicies: []interface{}{
&resourceAccessPolicyProperty{
resourceId: jsii.String("resourceId"),
// the properties below are optional
permission: jsii.String("permission"),
},
},
variables: variables,
},
execArgs: jsii.String("execArgs"),
executable: jsii.String("executable"),
memorySize: jsii.Number(123),
pinned: jsii.Boolean(false),
timeout: jsii.Number(123),
}
type CfnFunctionDefinitionVersion_FunctionProperty ¶
type CfnFunctionDefinitionVersion_FunctionProperty struct {
// The Amazon Resource Name (ARN) of the alias (recommended) or version of the referenced Lambda function.
FunctionArn *string `json:"functionArn" yaml:"functionArn"`
// The group-specific settings of the Lambda function.
//
// These settings configure the function's behavior in the Greengrass group.
FunctionConfiguration interface{} `json:"functionConfiguration" yaml:"functionConfiguration"`
// A descriptive or arbitrary ID for the function.
//
// This value must be unique within the function definition version. Maximum length is 128 characters with pattern `[a-zA-Z0-9:_-]+` .
Id *string `json:"id" yaml:"id"`
}
A function is a Lambda function that's referenced from an AWS IoT Greengrass group.
The function is deployed to a Greengrass core where it runs locally. For more information, see [Run Lambda Functions on the AWS IoT Greengrass Core](https://docs.aws.amazon.com/greengrass/latest/developerguide/lambda-functions.html) in the *Developer Guide* .
In an AWS CloudFormation template, the `Functions` property of the [`AWS::Greengrass::FunctionDefinitionVersion`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-functiondefinitionversion.html) resource contains a list of `Function` property types.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import greengrass "github.com/aws/aws-cdk-go/awscdk/aws_greengrass"
var variables interface{}
functionProperty := &functionProperty{
functionArn: jsii.String("functionArn"),
functionConfiguration: &functionConfigurationProperty{
encodingType: jsii.String("encodingType"),
environment: &environmentProperty{
accessSysfs: jsii.Boolean(false),
execution: &executionProperty{
isolationMode: jsii.String("isolationMode"),
runAs: &runAsProperty{
gid: jsii.Number(123),
uid: jsii.Number(123),
},
},
resourceAccessPolicies: []interface{}{
&resourceAccessPolicyProperty{
resourceId: jsii.String("resourceId"),
// the properties below are optional
permission: jsii.String("permission"),
},
},
variables: variables,
},
execArgs: jsii.String("execArgs"),
executable: jsii.String("executable"),
memorySize: jsii.Number(123),
pinned: jsii.Boolean(false),
timeout: jsii.Number(123),
},
id: jsii.String("id"),
}
type CfnFunctionDefinitionVersion_ResourceAccessPolicyProperty ¶
type CfnFunctionDefinitionVersion_ResourceAccessPolicyProperty struct {
// The ID of the resource.
//
// This ID is assigned to the resource when you create the resource definition.
ResourceId *string `json:"resourceId" yaml:"resourceId"`
// The read-only or read-write access that the Lambda function has to the resource.
//
// Valid values are `ro` or `rw` .
Permission *string `json:"permission" yaml:"permission"`
}
A list of the [resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-resourceinstance.html) in the group that the function can access, with the corresponding read-only or read-write permissions. The maximum is 10 resources.
> This property applies only to Lambda functions that run in a Greengrass container.
In an AWS CloudFormation template, `ResourceAccessPolicy` is a property of the [`Environment`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-environment.html) property type.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import greengrass "github.com/aws/aws-cdk-go/awscdk/aws_greengrass"
resourceAccessPolicyProperty := &resourceAccessPolicyProperty{
resourceId: jsii.String("resourceId"),
// the properties below are optional
permission: jsii.String("permission"),
}
type CfnFunctionDefinitionVersion_RunAsProperty ¶
type CfnFunctionDefinitionVersion_RunAsProperty struct {
// The group ID whose permissions are used to run the Lambda function.
//
// You can use the `getent group` command on your core device to look up the group ID.
Gid *float64 `json:"gid" yaml:"gid"`
// The user ID whose permissions are used to run the Lambda function.
//
// You can use the `getent passwd` command on your core device to look up the user ID.
Uid *float64 `json:"uid" yaml:"uid"`
}
The user and group permissions used to run the Lambda function.
This setting overrides the default access identity that's specified for the group (by default, ggc_user and ggc_group). You can override the user, group, or both. For more information, see [Run as](https://docs.aws.amazon.com/greengrass/latest/developerguide/lambda-group-config.html#lambda-access-identity.html) in the *Developer Guide* .
> Running as the root user increases risks to your data and device. Do not run as root (UID/GID=0) unless your business case requires it. For more information and requirements, see [Running a Lambda Function as Root](https://docs.aws.amazon.com/greengrass/latest/developerguide/lambda-group-config.html#lambda-running-as-root) .
In an AWS CloudFormation template, `RunAs` is a property of the [`Execution`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-execution.html) property type.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import greengrass "github.com/aws/aws-cdk-go/awscdk/aws_greengrass"
runAsProperty := &runAsProperty{
gid: jsii.Number(123),
uid: jsii.Number(123),
}
type CfnFunctionDefinition_DefaultConfigProperty ¶
type CfnFunctionDefinition_DefaultConfigProperty struct {
// Configuration settings for the Lambda execution environment on the AWS IoT Greengrass core.
Execution interface{} `json:"execution" yaml:"execution"`
}
The default configuration that applies to all Lambda functions in the function definition version.
Individual Lambda functions can override these settings.
In an AWS CloudFormation template, `DefaultConfig` is a property of the [`FunctionDefinitionVersion`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-functiondefinitionversion.html) property type.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import greengrass "github.com/aws/aws-cdk-go/awscdk/aws_greengrass"
defaultConfigProperty := &defaultConfigProperty{
execution: &executionProperty{
isolationMode: jsii.String("isolationMode"),
runAs: &runAsProperty{
gid: jsii.Number(123),
uid: jsii.Number(123),
},
},
}
type CfnFunctionDefinition_EnvironmentProperty ¶
type CfnFunctionDefinition_EnvironmentProperty struct {
// Indicates whether the function is allowed to access the `/sys` directory on the core device, which allows the read device information from `/sys` .
//
// > This property applies only to Lambda functions that run in a Greengrass container.
AccessSysfs interface{} `json:"accessSysfs" yaml:"accessSysfs"`
// Settings for the Lambda execution environment in AWS IoT Greengrass .
Execution interface{} `json:"execution" yaml:"execution"`
// A list of the [resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-resourceinstance.html) in the group that the function can access, with the corresponding read-only or read-write permissions. The maximum is 10 resources.
//
// > This property applies only for Lambda functions that run in a Greengrass container.
ResourceAccessPolicies interface{} `json:"resourceAccessPolicies" yaml:"resourceAccessPolicies"`
// Environment variables for the Lambda function.
Variables interface{} `json:"variables" yaml:"variables"`
}
The environment configuration for a Lambda function on the AWS IoT Greengrass core.
In an AWS CloudFormation template, `Environment` is a property of the [`FunctionConfiguration`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-functionconfiguration.html) property type.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import greengrass "github.com/aws/aws-cdk-go/awscdk/aws_greengrass"
var variables interface{}
environmentProperty := &environmentProperty{
accessSysfs: jsii.Boolean(false),
execution: &executionProperty{
isolationMode: jsii.String("isolationMode"),
runAs: &runAsProperty{
gid: jsii.Number(123),
uid: jsii.Number(123),
},
},
resourceAccessPolicies: []interface{}{
&resourceAccessPolicyProperty{
resourceId: jsii.String("resourceId"),
// the properties below are optional
permission: jsii.String("permission"),
},
},
variables: variables,
}
type CfnFunctionDefinition_ExecutionProperty ¶
type CfnFunctionDefinition_ExecutionProperty struct {
// The containerization that the Lambda function runs in.
//
// Valid values are `GreengrassContainer` or `NoContainer` . Typically, this is `GreengrassContainer` . For more information, see [Containerization](https://docs.aws.amazon.com/greengrass/latest/developerguide/lambda-group-config.html#lambda-function-containerization) in the *Developer Guide* .
//
// - When set on the [`DefaultConfig`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-defaultconfig.html) property of a function definition version, this setting is used as the default containerization for all Lambda functions in the function definition version.
// - When set on the [`Environment`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-environment.html) property of a function, this setting applies to the individual function and overrides the default. Omit this value to run the function with the default containerization.
//
// > We recommend that you run in a Greengrass container unless your business case requires that you run without containerization.
IsolationMode *string `json:"isolationMode" yaml:"isolationMode"`
// The user and group permissions used to run the Lambda function.
//
// Typically, this is the ggc_user and ggc_group. For more information, see [Run as](https://docs.aws.amazon.com/greengrass/latest/developerguide/lambda-group-config.html#lambda-access-identity.html) in the *Developer Guide* .
//
// - When set on the [`DefaultConfig`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-defaultconfig.html) property of a function definition version, this setting is used as the default access identity for all Lambda functions in the function definition version.
// - When set on the [`Environment`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-environment.html) property of a function, this setting applies to the individual function and overrides the default. You can override the user, group, or both. Omit this value to run the function with the default permissions.
//
// > Running as the root user increases risks to your data and device. Do not run as root (UID/GID=0) unless your business case requires it. For more information and requirements, see [Running a Lambda Function as Root](https://docs.aws.amazon.com/greengrass/latest/developerguide/lambda-group-config.html#lambda-running-as-root) .
RunAs interface{} `json:"runAs" yaml:"runAs"`
}
Configuration settings for the Lambda execution environment on the AWS IoT Greengrass core.
In an AWS CloudFormation template, `Execution` is a property of the [`DefaultConfig`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-defaultconfig.html) property type for a function definition version and the [`Environment`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-environment.html) property type for a function.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import greengrass "github.com/aws/aws-cdk-go/awscdk/aws_greengrass"
executionProperty := &executionProperty{
isolationMode: jsii.String("isolationMode"),
runAs: &runAsProperty{
gid: jsii.Number(123),
uid: jsii.Number(123),
},
}
type CfnFunctionDefinition_FunctionConfigurationProperty ¶
type CfnFunctionDefinition_FunctionConfigurationProperty struct {
// The expected encoding type of the input payload for the function.
//
// Valid values are `json` (default) and `binary` .
EncodingType *string `json:"encodingType" yaml:"encodingType"`
// The environment configuration of the function.
Environment interface{} `json:"environment" yaml:"environment"`
// The execution arguments.
ExecArgs *string `json:"execArgs" yaml:"execArgs"`
// The name of the function executable.
Executable *string `json:"executable" yaml:"executable"`
// The memory size (in KB) required by the function.
//
// > This property applies only to Lambda functions that run in a Greengrass container.
MemorySize *float64 `json:"memorySize" yaml:"memorySize"`
// Indicates whether the function is pinned (or *long-lived* ).
//
// Pinned functions start when the core starts and process all requests in the same container. The default value is false.
Pinned interface{} `json:"pinned" yaml:"pinned"`
// The allowed execution time (in seconds) after which the function should terminate.
//
// For pinned functions, this timeout applies for each request.
Timeout *float64 `json:"timeout" yaml:"timeout"`
}
The group-specific configuration settings for a Lambda function.
These settings configure the function's behavior in the Greengrass group. For more information, see [Controlling Execution of Greengrass Lambda Functions by Using Group-Specific Configuration](https://docs.aws.amazon.com/greengrass/latest/developerguide/lambda-group-config.html) in the *Developer Guide* .
In an AWS CloudFormation template, `FunctionConfiguration` is a property of the [`Function`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-function.html) property type.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import greengrass "github.com/aws/aws-cdk-go/awscdk/aws_greengrass"
var variables interface{}
functionConfigurationProperty := &functionConfigurationProperty{
encodingType: jsii.String("encodingType"),
environment: &environmentProperty{
accessSysfs: jsii.Boolean(false),
execution: &executionProperty{
isolationMode: jsii.String("isolationMode"),
runAs: &runAsProperty{
gid: jsii.Number(123),
uid: jsii.Number(123),
},
},
resourceAccessPolicies: []interface{}{
&resourceAccessPolicyProperty{
resourceId: jsii.String("resourceId"),
// the properties below are optional
permission: jsii.String("permission"),
},
},
variables: variables,
},
execArgs: jsii.String("execArgs"),
executable: jsii.String("executable"),
memorySize: jsii.Number(123),
pinned: jsii.Boolean(false),
timeout: jsii.Number(123),
}
type CfnFunctionDefinition_FunctionDefinitionVersionProperty ¶
type CfnFunctionDefinition_FunctionDefinitionVersionProperty struct {
// The functions in this version.
Functions interface{} `json:"functions" yaml:"functions"`
// The default configuration that applies to all Lambda functions in the group.
//
// Individual Lambda functions can override these settings.
DefaultConfig interface{} `json:"defaultConfig" yaml:"defaultConfig"`
}
A function definition version contains a list of functions.
> After you create a function definition version that contains the functions you want to deploy, you must add it to your group version. For more information, see [`AWS::Greengrass::Group`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html) .
In an AWS CloudFormation template, `FunctionDefinitionVersion` is the property type of the `InitialVersion` property in the [`AWS::Greengrass::FunctionDefinition`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-functiondefinition.html) resource.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import greengrass "github.com/aws/aws-cdk-go/awscdk/aws_greengrass"
var variables interface{}
functionDefinitionVersionProperty := &functionDefinitionVersionProperty{
functions: []interface{}{
&functionProperty{
functionArn: jsii.String("functionArn"),
functionConfiguration: &functionConfigurationProperty{
encodingType: jsii.String("encodingType"),
environment: &environmentProperty{
accessSysfs: jsii.Boolean(false),
execution: &executionProperty{
isolationMode: jsii.String("isolationMode"),
runAs: &runAsProperty{
gid: jsii.Number(123),
uid: jsii.Number(123),
},
},
resourceAccessPolicies: []interface{}{
&resourceAccessPolicyProperty{
resourceId: jsii.String("resourceId"),
// the properties below are optional
permission: jsii.String("permission"),
},
},
variables: variables,
},
execArgs: jsii.String("execArgs"),
executable: jsii.String("executable"),
memorySize: jsii.Number(123),
pinned: jsii.Boolean(false),
timeout: jsii.Number(123),
},
id: jsii.String("id"),
},
},
// the properties below are optional
defaultConfig: &defaultConfigProperty{
execution: &executionProperty{
isolationMode: jsii.String("isolationMode"),
runAs: &runAsProperty{
gid: jsii.Number(123),
uid: jsii.Number(123),
},
},
},
}
type CfnFunctionDefinition_FunctionProperty ¶
type CfnFunctionDefinition_FunctionProperty struct {
// The Amazon Resource Name (ARN) of the alias (recommended) or version of the referenced Lambda function.
FunctionArn *string `json:"functionArn" yaml:"functionArn"`
// The group-specific settings of the Lambda function.
//
// These settings configure the function's behavior in the Greengrass group.
FunctionConfiguration interface{} `json:"functionConfiguration" yaml:"functionConfiguration"`
// A descriptive or arbitrary ID for the function.
//
// This value must be unique within the function definition version. Maximum length is 128 characters with pattern `[a-zA-Z0-9:_-]+` .
Id *string `json:"id" yaml:"id"`
}
A function is a Lambda function that's referenced from an AWS IoT Greengrass group.
The function is deployed to a Greengrass core where it runs locally. For more information, see [Run Lambda Functions on the AWS IoT Greengrass Core](https://docs.aws.amazon.com/greengrass/latest/developerguide/lambda-functions.html) in the *Developer Guide* .
In an AWS CloudFormation template, the `Functions` property of the [`FunctionDefinitionVersion`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-functiondefinitionversion.html) property type contains a list of `Function` property types.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import greengrass "github.com/aws/aws-cdk-go/awscdk/aws_greengrass"
var variables interface{}
functionProperty := &functionProperty{
functionArn: jsii.String("functionArn"),
functionConfiguration: &functionConfigurationProperty{
encodingType: jsii.String("encodingType"),
environment: &environmentProperty{
accessSysfs: jsii.Boolean(false),
execution: &executionProperty{
isolationMode: jsii.String("isolationMode"),
runAs: &runAsProperty{
gid: jsii.Number(123),
uid: jsii.Number(123),
},
},
resourceAccessPolicies: []interface{}{
&resourceAccessPolicyProperty{
resourceId: jsii.String("resourceId"),
// the properties below are optional
permission: jsii.String("permission"),
},
},
variables: variables,
},
execArgs: jsii.String("execArgs"),
executable: jsii.String("executable"),
memorySize: jsii.Number(123),
pinned: jsii.Boolean(false),
timeout: jsii.Number(123),
},
id: jsii.String("id"),
}
type CfnFunctionDefinition_ResourceAccessPolicyProperty ¶
type CfnFunctionDefinition_ResourceAccessPolicyProperty struct {
// The ID of the resource.
//
// This ID is assigned to the resource when you create the resource definition.
ResourceId *string `json:"resourceId" yaml:"resourceId"`
// The read-only or read-write access that the Lambda function has to the resource.
//
// Valid values are `ro` or `rw` .
Permission *string `json:"permission" yaml:"permission"`
}
A list of the [resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-resourceinstance.html) in the group that the function can access, with the corresponding read-only or read-write permissions. The maximum is 10 resources.
> This property applies only to Lambda functions that run in a Greengrass container.
In an AWS CloudFormation template, `ResourceAccessPolicy` is a property of the [`Environment`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-environment.html) property type.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import greengrass "github.com/aws/aws-cdk-go/awscdk/aws_greengrass"
resourceAccessPolicyProperty := &resourceAccessPolicyProperty{
resourceId: jsii.String("resourceId"),
// the properties below are optional
permission: jsii.String("permission"),
}
type CfnFunctionDefinition_RunAsProperty ¶
type CfnFunctionDefinition_RunAsProperty struct {
// The group ID whose permissions are used to run the Lambda function.
//
// You can use the `getent group` command on your core device to look up the group ID.
Gid *float64 `json:"gid" yaml:"gid"`
// The user ID whose permissions are used to run the Lambda function.
//
// You can use the `getent passwd` command on your core device to look up the user ID.
Uid *float64 `json:"uid" yaml:"uid"`
}
The access identity whose permissions are used to run the Lambda function.
This setting overrides the default access identity that's specified for the group (by default, ggc_user and ggc_group). You can override the user, group, or both. For more information, see [Run as](https://docs.aws.amazon.com/greengrass/latest/developerguide/lambda-group-config.html#lambda-access-identity.html) in the *Developer Guide* .
> Running as the root user increases risks to your data and device. Do not run as root (UID/GID=0) unless your business case requires it. For more information and requirements, see [Running a Lambda Function as Root](https://docs.aws.amazon.com/greengrass/latest/developerguide/lambda-group-config.html#lambda-running-as-root) .
In an AWS CloudFormation template, `RunAs` is a property of the [`Execution`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-execution.html) property type.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import greengrass "github.com/aws/aws-cdk-go/awscdk/aws_greengrass"
runAsProperty := &runAsProperty{
gid: jsii.Number(123),
uid: jsii.Number(123),
}
type CfnGroup ¶
type CfnGroup interface {
awscdk.CfnResource
awscdk.IInspectable
// The ARN of the `Group` , such as `arn:aws:greengrass:us-east-1: :/greengrass/definition/groups/1234a5b6-78cd-901e-2fgh-3i45j6k178l9` .
AttrArn() *string
// The ID of the `Group` , such as `1234a5b6-78cd-901e-2fgh-3i45j6k178l9` .
AttrId() *string
// The ARN of the last `GroupVersion` that was added to the `Group` , such as `arn:aws:greengrass:us-east-1: :/greengrass/definition/groups/1234a5b6-78cd-901e-2fgh-3i45j6k178l9/versions/9876ac30-4bdb-4f9d-95af-b5fdb66be1a2` .
AttrLatestVersionArn() *string
// The name of the `Group` , such as `MyGroup` .
AttrName() *string
// The ARN of the IAM role that's attached to the `Group` , such as `arn:aws:iam:: :role/role-name` .
AttrRoleArn() *string
// The time (in milliseconds since the epoch) when the group role was attached to the `Group` .
AttrRoleAttachedAt() *string
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
// Returns: 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.
CreationStack() *[]*string
// The group version to include when the group is created.
//
// A group version references the Amazon Resource Name (ARN) of a core definition version, device definition version, subscription definition version, and other version types. The group version must reference a core definition version that contains one core. Other version types are optionally included, depending on your business need.
//
// > To associate a group version after the group is created, create an [`AWS::Greengrass::GroupVersion`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-groupversion.html) resource and specify the ID of this group.
InitialVersion() interface{}
SetInitialVersion(val interface{})
// 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)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
LogicalId() *string
// The name of the group.
Name() *string
SetName(val *string)
// The tree node.
Node() constructs.Node
// 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 })`.
Ref() *string
// The Amazon Resource Name (ARN) of the IAM role attached to the group.
//
// This role contains the permissions that Lambda functions and connectors use to interact with other AWS services.
RoleArn() *string
SetRoleArn(val *string)
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// Application-specific metadata to attach to the group.
//
// You can use tags in IAM policies to control access to AWS IoT Greengrass resources. You can also use tags to categorize your resources. For more information, see [Tagging Your AWS IoT Greengrass Resources](https://docs.aws.amazon.com/greengrass/latest/developerguide/tagging.html) in the *Developer Guide* .
//
// This `Json` property type is processed as a map of key-value pairs. It uses the following format, which is different from most `Tags` implementations in AWS CloudFormation templates.
//
// “`json
// "Tags": { "KeyName0": "value", "KeyName1": "value", "KeyName2": "value"
// }
// “`.
Tags() awscdk.TagManager
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// 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.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// 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.
//
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` 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,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` 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.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
// 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`).
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
// 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.
GetAtt(attributeName *string) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// 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.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::Greengrass::Group`.
AWS IoT Greengrass seamlessly extends AWS to edge devices so they can act locally on the data they generate, while still using the cloud for management, analytics, and durable storage. With AWS IoT Greengrass , connected devices can run AWS Lambda functions, execute predictions based on machine learning models, keep device data in sync, and communicate with other devices securely – even when not connected to the internet. For more information, see the [Developer Guide](https://docs.aws.amazon.com/greengrass/latest/developerguide/what-is-gg.html) .
> For AWS Region support, see [AWS CloudFormation Support for AWS IoT Greengrass](https://docs.aws.amazon.com/greengrass/latest/developerguide/cloudformation-support.html) in the *Developer Guide* .
The `AWS::Greengrass::Group` resource represents a group in AWS IoT Greengrass . In the AWS IoT Greengrass API, groups are used to organize your group versions.
Groups can reference multiple group versions. All group versions must be associated with a group. A group version references a device definition version, subscription definition version, and other version types that contain the components you want to deploy to a Greengrass core device.
To deploy a group version, the group version must reference a core definition version that contains one core. Other version types are optionally included, depending on your business need.
> When you create a group, you can optionally include an initial group version. To associate a group version later, create a [`AWS::Greengrass::GroupVersion`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-groupversion.html) resource and specify the ID of this group. > > To change group components (such as devices, subscriptions, or functions), you must create new versions. This is because versions are immutable. For example, to add a function, you create a function definition version that contains the new function (and all other functions that you want to deploy). Then you create a group version that references the new function definition version (and all other version types that you want to deploy).
*Deploying a Group Version*
After you create the group version in your AWS CloudFormation template, you can deploy it using the [`aws greengrass create-deployment`](https://docs.aws.amazon.com/greengrass/latest/apireference/createdeployment-post.html) command in the AWS CLI or from the *Greengrass* node in the AWS IoT console. To deploy a group version, you must have a Greengrass service role associated with your AWS account . For more information, see [AWS CloudFormation Support for AWS IoT Greengrass](https://docs.aws.amazon.com/greengrass/latest/developerguide/cloudformation-support.html) in the *Developer Guide* .
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import greengrass "github.com/aws/aws-cdk-go/awscdk/aws_greengrass"
var tags interface{}
cfnGroup := greengrass.NewCfnGroup(this, jsii.String("MyCfnGroup"), &cfnGroupProps{
name: jsii.String("name"),
// the properties below are optional
initialVersion: &groupVersionProperty{
connectorDefinitionVersionArn: jsii.String("connectorDefinitionVersionArn"),
coreDefinitionVersionArn: jsii.String("coreDefinitionVersionArn"),
deviceDefinitionVersionArn: jsii.String("deviceDefinitionVersionArn"),
functionDefinitionVersionArn: jsii.String("functionDefinitionVersionArn"),
loggerDefinitionVersionArn: jsii.String("loggerDefinitionVersionArn"),
resourceDefinitionVersionArn: jsii.String("resourceDefinitionVersionArn"),
subscriptionDefinitionVersionArn: jsii.String("subscriptionDefinitionVersionArn"),
},
roleArn: jsii.String("roleArn"),
tags: tags,
})
func NewCfnGroup ¶
func NewCfnGroup(scope constructs.Construct, id *string, props *CfnGroupProps) CfnGroup
Create a new `AWS::Greengrass::Group`.
type CfnGroupProps ¶
type CfnGroupProps struct {
// The name of the group.
Name *string `json:"name" yaml:"name"`
// The group version to include when the group is created.
//
// A group version references the Amazon Resource Name (ARN) of a core definition version, device definition version, subscription definition version, and other version types. The group version must reference a core definition version that contains one core. Other version types are optionally included, depending on your business need.
//
// > To associate a group version after the group is created, create an [`AWS::Greengrass::GroupVersion`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-groupversion.html) resource and specify the ID of this group.
InitialVersion interface{} `json:"initialVersion" yaml:"initialVersion"`
// The Amazon Resource Name (ARN) of the IAM role attached to the group.
//
// This role contains the permissions that Lambda functions and connectors use to interact with other AWS services.
RoleArn *string `json:"roleArn" yaml:"roleArn"`
// Application-specific metadata to attach to the group.
//
// You can use tags in IAM policies to control access to AWS IoT Greengrass resources. You can also use tags to categorize your resources. For more information, see [Tagging Your AWS IoT Greengrass Resources](https://docs.aws.amazon.com/greengrass/latest/developerguide/tagging.html) in the *Developer Guide* .
//
// This `Json` property type is processed as a map of key-value pairs. It uses the following format, which is different from most `Tags` implementations in AWS CloudFormation templates.
//
// “`json
// "Tags": { "KeyName0": "value", "KeyName1": "value", "KeyName2": "value"
// }
// “`.
Tags interface{} `json:"tags" yaml:"tags"`
}
Properties for defining a `CfnGroup`.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import greengrass "github.com/aws/aws-cdk-go/awscdk/aws_greengrass"
var tags interface{}
cfnGroupProps := &cfnGroupProps{
name: jsii.String("name"),
// the properties below are optional
initialVersion: &groupVersionProperty{
connectorDefinitionVersionArn: jsii.String("connectorDefinitionVersionArn"),
coreDefinitionVersionArn: jsii.String("coreDefinitionVersionArn"),
deviceDefinitionVersionArn: jsii.String("deviceDefinitionVersionArn"),
functionDefinitionVersionArn: jsii.String("functionDefinitionVersionArn"),
loggerDefinitionVersionArn: jsii.String("loggerDefinitionVersionArn"),
resourceDefinitionVersionArn: jsii.String("resourceDefinitionVersionArn"),
subscriptionDefinitionVersionArn: jsii.String("subscriptionDefinitionVersionArn"),
},
roleArn: jsii.String("roleArn"),
tags: tags,
}
type CfnGroupVersion ¶
type CfnGroupVersion interface {
awscdk.CfnResource
awscdk.IInspectable
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
// The Amazon Resource Name (ARN) of the connector definition version that contains the connectors you want to deploy with the group version.
ConnectorDefinitionVersionArn() *string
SetConnectorDefinitionVersionArn(val *string)
// The ARN of the core definition version that contains the core you want to deploy with the group version.
//
// Currently, the core definition version can contain only one core.
CoreDefinitionVersionArn() *string
SetCoreDefinitionVersionArn(val *string)
// Returns: 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.
CreationStack() *[]*string
// The ARN of the device definition version that contains the devices you want to deploy with the group version.
DeviceDefinitionVersionArn() *string
SetDeviceDefinitionVersionArn(val *string)
// The ARN of the function definition version that contains the functions you want to deploy with the group version.
FunctionDefinitionVersionArn() *string
SetFunctionDefinitionVersionArn(val *string)
// The ID of the group associated with this version.
//
// This value is a GUID.
GroupId() *string
SetGroupId(val *string)
// The ARN of the logger definition version that contains the loggers you want to deploy with the group version.
LoggerDefinitionVersionArn() *string
SetLoggerDefinitionVersionArn(val *string)
// 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)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
LogicalId() *string
// The tree node.
Node() constructs.Node
// 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 })`.
Ref() *string
// The ARN of the resource definition version that contains the resources you want to deploy with the group version.
ResourceDefinitionVersionArn() *string
SetResourceDefinitionVersionArn(val *string)
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// The ARN of the subscription definition version that contains the subscriptions you want to deploy with the group version.
SubscriptionDefinitionVersionArn() *string
SetSubscriptionDefinitionVersionArn(val *string)
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// 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.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// 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.
//
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` 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,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` 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.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
// 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`).
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
// 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.
GetAtt(attributeName *string) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// 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.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::Greengrass::GroupVersion`.
The `AWS::Greengrass::GroupVersion` resource represents a group version in AWS IoT Greengrass . A group version references a core definition version, device definition version, subscription definition version, and other version types that contain the components you want to deploy to a Greengrass core device. The group version must reference a core definition version that contains one core. Other version types are optionally included, depending on your business need.
> To create a group version, you must specify the ID of the group that you want to associate with the version. For information about creating a group, see [`AWS::Greengrass::Group`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html) .
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import greengrass "github.com/aws/aws-cdk-go/awscdk/aws_greengrass"
cfnGroupVersion := greengrass.NewCfnGroupVersion(this, jsii.String("MyCfnGroupVersion"), &cfnGroupVersionProps{
groupId: jsii.String("groupId"),
// the properties below are optional
connectorDefinitionVersionArn: jsii.String("connectorDefinitionVersionArn"),
coreDefinitionVersionArn: jsii.String("coreDefinitionVersionArn"),
deviceDefinitionVersionArn: jsii.String("deviceDefinitionVersionArn"),
functionDefinitionVersionArn: jsii.String("functionDefinitionVersionArn"),
loggerDefinitionVersionArn: jsii.String("loggerDefinitionVersionArn"),
resourceDefinitionVersionArn: jsii.String("resourceDefinitionVersionArn"),
subscriptionDefinitionVersionArn: jsii.String("subscriptionDefinitionVersionArn"),
})
func NewCfnGroupVersion ¶
func NewCfnGroupVersion(scope constructs.Construct, id *string, props *CfnGroupVersionProps) CfnGroupVersion
Create a new `AWS::Greengrass::GroupVersion`.
type CfnGroupVersionProps ¶
type CfnGroupVersionProps struct {
// The ID of the group associated with this version.
//
// This value is a GUID.
GroupId *string `json:"groupId" yaml:"groupId"`
// The Amazon Resource Name (ARN) of the connector definition version that contains the connectors you want to deploy with the group version.
ConnectorDefinitionVersionArn *string `json:"connectorDefinitionVersionArn" yaml:"connectorDefinitionVersionArn"`
// The ARN of the core definition version that contains the core you want to deploy with the group version.
//
// Currently, the core definition version can contain only one core.
CoreDefinitionVersionArn *string `json:"coreDefinitionVersionArn" yaml:"coreDefinitionVersionArn"`
// The ARN of the device definition version that contains the devices you want to deploy with the group version.
DeviceDefinitionVersionArn *string `json:"deviceDefinitionVersionArn" yaml:"deviceDefinitionVersionArn"`
// The ARN of the function definition version that contains the functions you want to deploy with the group version.
FunctionDefinitionVersionArn *string `json:"functionDefinitionVersionArn" yaml:"functionDefinitionVersionArn"`
// The ARN of the logger definition version that contains the loggers you want to deploy with the group version.
LoggerDefinitionVersionArn *string `json:"loggerDefinitionVersionArn" yaml:"loggerDefinitionVersionArn"`
// The ARN of the resource definition version that contains the resources you want to deploy with the group version.
ResourceDefinitionVersionArn *string `json:"resourceDefinitionVersionArn" yaml:"resourceDefinitionVersionArn"`
// The ARN of the subscription definition version that contains the subscriptions you want to deploy with the group version.
SubscriptionDefinitionVersionArn *string `json:"subscriptionDefinitionVersionArn" yaml:"subscriptionDefinitionVersionArn"`
}
Properties for defining a `CfnGroupVersion`.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import greengrass "github.com/aws/aws-cdk-go/awscdk/aws_greengrass"
cfnGroupVersionProps := &cfnGroupVersionProps{
groupId: jsii.String("groupId"),
// the properties below are optional
connectorDefinitionVersionArn: jsii.String("connectorDefinitionVersionArn"),
coreDefinitionVersionArn: jsii.String("coreDefinitionVersionArn"),
deviceDefinitionVersionArn: jsii.String("deviceDefinitionVersionArn"),
functionDefinitionVersionArn: jsii.String("functionDefinitionVersionArn"),
loggerDefinitionVersionArn: jsii.String("loggerDefinitionVersionArn"),
resourceDefinitionVersionArn: jsii.String("resourceDefinitionVersionArn"),
subscriptionDefinitionVersionArn: jsii.String("subscriptionDefinitionVersionArn"),
}
type CfnGroup_GroupVersionProperty ¶
type CfnGroup_GroupVersionProperty struct {
// The Amazon Resource Name (ARN) of the connector definition version that contains the connectors you want to deploy with the group version.
ConnectorDefinitionVersionArn *string `json:"connectorDefinitionVersionArn" yaml:"connectorDefinitionVersionArn"`
// The ARN of the core definition version that contains the core you want to deploy with the group version.
//
// Currently, the core definition version can contain only one core.
CoreDefinitionVersionArn *string `json:"coreDefinitionVersionArn" yaml:"coreDefinitionVersionArn"`
// The ARN of the device definition version that contains the devices you want to deploy with the group version.
DeviceDefinitionVersionArn *string `json:"deviceDefinitionVersionArn" yaml:"deviceDefinitionVersionArn"`
// The ARN of the function definition version that contains the functions you want to deploy with the group version.
FunctionDefinitionVersionArn *string `json:"functionDefinitionVersionArn" yaml:"functionDefinitionVersionArn"`
// The ARN of the logger definition version that contains the loggers you want to deploy with the group version.
LoggerDefinitionVersionArn *string `json:"loggerDefinitionVersionArn" yaml:"loggerDefinitionVersionArn"`
// The ARN of the resource definition version that contains the resources you want to deploy with the group version.
ResourceDefinitionVersionArn *string `json:"resourceDefinitionVersionArn" yaml:"resourceDefinitionVersionArn"`
// The ARN of the subscription definition version that contains the subscriptions you want to deploy with the group version.
SubscriptionDefinitionVersionArn *string `json:"subscriptionDefinitionVersionArn" yaml:"subscriptionDefinitionVersionArn"`
}
A group version in AWS IoT Greengrass , which references of a core definition version, device definition version, subscription definition version, and other version types that contain the components you want to deploy to a Greengrass core device.
The group version must reference a core definition version that contains one core. Other version types are optionally included, depending on your business need.
In an AWS CloudFormation template, `GroupVersion` is the property type of the `InitialVersion` property in the [`AWS::Greengrass::Group`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html) resource.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import greengrass "github.com/aws/aws-cdk-go/awscdk/aws_greengrass"
groupVersionProperty := &groupVersionProperty{
connectorDefinitionVersionArn: jsii.String("connectorDefinitionVersionArn"),
coreDefinitionVersionArn: jsii.String("coreDefinitionVersionArn"),
deviceDefinitionVersionArn: jsii.String("deviceDefinitionVersionArn"),
functionDefinitionVersionArn: jsii.String("functionDefinitionVersionArn"),
loggerDefinitionVersionArn: jsii.String("loggerDefinitionVersionArn"),
resourceDefinitionVersionArn: jsii.String("resourceDefinitionVersionArn"),
subscriptionDefinitionVersionArn: jsii.String("subscriptionDefinitionVersionArn"),
}
type CfnLoggerDefinition ¶
type CfnLoggerDefinition interface {
awscdk.CfnResource
awscdk.IInspectable
// The Amazon Resource Name (ARN) of the `LoggerDefinition` , such as `arn:aws:greengrass:us-east-1: :/greengrass/definition/loggers/1234a5b6-78cd-901e-2fgh-3i45j6k178l9` .
AttrArn() *string
// The ID of the `LoggerDefinition` , such as `1234a5b6-78cd-901e-2fgh-3i45j6k178l9` .
AttrId() *string
// The ARN of the last `LoggerDefinitionVersion` that was added to the `LoggerDefinition` , such as `arn:aws:greengrass:us-east-1: :/greengrass/definition/loggers/1234a5b6-78cd-901e-2fgh-3i45j6k178l9/versions/9876ac30-4bdb-4f9d-95af-b5fdb66be1a2` .
AttrLatestVersionArn() *string
// The name of the `LoggerDefinition` , such as `MyLoggerDefinition` .
AttrName() *string
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
// Returns: 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.
CreationStack() *[]*string
// The logger definition version to include when the logger definition is created.
//
// A logger definition version contains a list of [`logger`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-loggerdefinition-logger.html) property types.
//
// > To associate a logger definition version after the logger definition is created, create an [`AWS::Greengrass::LoggerDefinitionVersion`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-loggerdefinitionversion.html) resource and specify the ID of this logger definition.
InitialVersion() interface{}
SetInitialVersion(val interface{})
// 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)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
LogicalId() *string
// The name of the logger definition.
Name() *string
SetName(val *string)
// The tree node.
Node() constructs.Node
// 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 })`.
Ref() *string
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// Application-specific metadata to attach to the logger definition.
//
// You can use tags in IAM policies to control access to AWS IoT Greengrass resources. You can also use tags to categorize your resources. For more information, see [Tagging Your AWS IoT Greengrass Resources](https://docs.aws.amazon.com/greengrass/latest/developerguide/tagging.html) in the *Developer Guide* .
//
// This `Json` property type is processed as a map of key-value pairs. It uses the following format, which is different from most `Tags` implementations in AWS CloudFormation templates.
//
// “`json
// "Tags": { "KeyName0": "value", "KeyName1": "value", "KeyName2": "value"
// }
// “`.
Tags() awscdk.TagManager
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// 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.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// 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.
//
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` 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,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` 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.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
// 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`).
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
// 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.
GetAtt(attributeName *string) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// 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.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::Greengrass::LoggerDefinition`.
The `AWS::Greengrass::LoggerDefinition` resource represents a logger definition for AWS IoT Greengrass . Logger definitions are used to organize your logger definition versions.
Logger definitions can reference multiple logger definition versions. All logger definition versions must be associated with a logger definition. Each logger definition version can contain one or more loggers.
> When you create a logger definition, you can optionally include an initial logger definition version. To associate a logger definition version later, create an [`AWS::Greengrass::LoggerDefinitionVersion`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-loggerdefinitionversion.html) resource and specify the ID of this logger definition. > > After you create the logger definition version that contains the loggers you want to deploy, you must add it to your group version. For more information, see [`AWS::Greengrass::Group`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html) .
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import greengrass "github.com/aws/aws-cdk-go/awscdk/aws_greengrass"
var tags interface{}
cfnLoggerDefinition := greengrass.NewCfnLoggerDefinition(this, jsii.String("MyCfnLoggerDefinition"), &cfnLoggerDefinitionProps{
name: jsii.String("name"),
// the properties below are optional
initialVersion: &loggerDefinitionVersionProperty{
loggers: []interface{}{
&loggerProperty{
component: jsii.String("component"),
id: jsii.String("id"),
level: jsii.String("level"),
type: jsii.String("type"),
// the properties below are optional
space: jsii.Number(123),
},
},
},
tags: tags,
})
func NewCfnLoggerDefinition ¶
func NewCfnLoggerDefinition(scope constructs.Construct, id *string, props *CfnLoggerDefinitionProps) CfnLoggerDefinition
Create a new `AWS::Greengrass::LoggerDefinition`.
type CfnLoggerDefinitionProps ¶
type CfnLoggerDefinitionProps struct {
// The name of the logger definition.
Name *string `json:"name" yaml:"name"`
// The logger definition version to include when the logger definition is created.
//
// A logger definition version contains a list of [`logger`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-loggerdefinition-logger.html) property types.
//
// > To associate a logger definition version after the logger definition is created, create an [`AWS::Greengrass::LoggerDefinitionVersion`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-loggerdefinitionversion.html) resource and specify the ID of this logger definition.
InitialVersion interface{} `json:"initialVersion" yaml:"initialVersion"`
// Application-specific metadata to attach to the logger definition.
//
// You can use tags in IAM policies to control access to AWS IoT Greengrass resources. You can also use tags to categorize your resources. For more information, see [Tagging Your AWS IoT Greengrass Resources](https://docs.aws.amazon.com/greengrass/latest/developerguide/tagging.html) in the *Developer Guide* .
//
// This `Json` property type is processed as a map of key-value pairs. It uses the following format, which is different from most `Tags` implementations in AWS CloudFormation templates.
//
// “`json
// "Tags": { "KeyName0": "value", "KeyName1": "value", "KeyName2": "value"
// }
// “`.
Tags interface{} `json:"tags" yaml:"tags"`
}
Properties for defining a `CfnLoggerDefinition`.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import greengrass "github.com/aws/aws-cdk-go/awscdk/aws_greengrass"
var tags interface{}
cfnLoggerDefinitionProps := &cfnLoggerDefinitionProps{
name: jsii.String("name"),
// the properties below are optional
initialVersion: &loggerDefinitionVersionProperty{
loggers: []interface{}{
&loggerProperty{
component: jsii.String("component"),
id: jsii.String("id"),
level: jsii.String("level"),
type: jsii.String("type"),
// the properties below are optional
space: jsii.Number(123),
},
},
},
tags: tags,
}
type CfnLoggerDefinitionVersion ¶
type CfnLoggerDefinitionVersion interface {
awscdk.CfnResource
awscdk.IInspectable
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
// Returns: 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.
CreationStack() *[]*string
// The ID of the logger definition associated with this version.
//
// This value is a GUID.
LoggerDefinitionId() *string
SetLoggerDefinitionId(val *string)
// The loggers in this version.
Loggers() interface{}
SetLoggers(val interface{})
// 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)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
LogicalId() *string
// The tree node.
Node() constructs.Node
// 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 })`.
Ref() *string
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// 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.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// 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.
//
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` 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,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` 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.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
// 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`).
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
// 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.
GetAtt(attributeName *string) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// 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.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::Greengrass::LoggerDefinitionVersion`.
The `AWS::Greengrass::LoggerDefinitionVersion` resource represents a logger definition version for AWS IoT Greengrass . A logger definition version contains a list of loggers.
> To create a logger definition version, you must specify the ID of the logger definition that you want to associate with the version. For information about creating a logger definition, see [`AWS::Greengrass::LoggerDefinition`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-loggerdefinition.html) . > > After you create a logger definition version that contains the loggers you want to deploy, you must add it to your group version. For more information, see [`AWS::Greengrass::Group`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html) .
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import greengrass "github.com/aws/aws-cdk-go/awscdk/aws_greengrass"
cfnLoggerDefinitionVersion := greengrass.NewCfnLoggerDefinitionVersion(this, jsii.String("MyCfnLoggerDefinitionVersion"), &cfnLoggerDefinitionVersionProps{
loggerDefinitionId: jsii.String("loggerDefinitionId"),
loggers: []interface{}{
&loggerProperty{
component: jsii.String("component"),
id: jsii.String("id"),
level: jsii.String("level"),
type: jsii.String("type"),
// the properties below are optional
space: jsii.Number(123),
},
},
})
func NewCfnLoggerDefinitionVersion ¶
func NewCfnLoggerDefinitionVersion(scope constructs.Construct, id *string, props *CfnLoggerDefinitionVersionProps) CfnLoggerDefinitionVersion
Create a new `AWS::Greengrass::LoggerDefinitionVersion`.
type CfnLoggerDefinitionVersionProps ¶
type CfnLoggerDefinitionVersionProps struct {
// The ID of the logger definition associated with this version.
//
// This value is a GUID.
LoggerDefinitionId *string `json:"loggerDefinitionId" yaml:"loggerDefinitionId"`
// The loggers in this version.
Loggers interface{} `json:"loggers" yaml:"loggers"`
}
Properties for defining a `CfnLoggerDefinitionVersion`.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import greengrass "github.com/aws/aws-cdk-go/awscdk/aws_greengrass"
cfnLoggerDefinitionVersionProps := &cfnLoggerDefinitionVersionProps{
loggerDefinitionId: jsii.String("loggerDefinitionId"),
loggers: []interface{}{
&loggerProperty{
component: jsii.String("component"),
id: jsii.String("id"),
level: jsii.String("level"),
type: jsii.String("type"),
// the properties below are optional
space: jsii.Number(123),
},
},
}
type CfnLoggerDefinitionVersion_LoggerProperty ¶
type CfnLoggerDefinitionVersion_LoggerProperty struct {
// The source of the log event.
//
// Valid values are `GreengrassSystem` or `Lambda` . When `GreengrassSystem` is used, events from Greengrass system components are logged. When `Lambda` is used, events from user-defined Lambda functions are logged.
Component *string `json:"component" yaml:"component"`
// A descriptive or arbitrary ID for the logger.
//
// This value must be unique within the logger definition version. Maximum length is 128 characters with pattern `[a-zA-Z0-9:_-]+` .
Id *string `json:"id" yaml:"id"`
// The log-level threshold.
//
// Log events below this threshold are filtered out and aren't stored. Valid values are `DEBUG` , `INFO` (recommended), `WARN` , `ERROR` , or `FATAL` .
Level *string `json:"level" yaml:"level"`
// The storage mechanism for log events.
//
// Valid values are `FileSystem` or `AWSCloudWatch` . When `AWSCloudWatch` is used, log events are sent to CloudWatch Logs . When `FileSystem` is used, log events are stored on the local file system.
Type *string `json:"type" yaml:"type"`
// The amount of file space (in KB) to use when writing logs to the local file system.
//
// This property does not apply for CloudWatch Logs .
Space *float64 `json:"space" yaml:"space"`
}
A logger represents logging settings for the AWS IoT Greengrass group, which can be stored in CloudWatch and the local file system of your core device.
All log entries include a timestamp, log level, and information about the event. For more information, see [Monitoring with AWS IoT Greengrass Logs](https://docs.aws.amazon.com/greengrass/latest/developerguide/greengrass-logs-overview.html) in the *Developer Guide* .
In an AWS CloudFormation template, the `Loggers` property of the [`AWS::Greengrass::LoggerDefinitionVersion`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-loggerdefinitionversion.html) resource contains a list of `Logger` property types.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import greengrass "github.com/aws/aws-cdk-go/awscdk/aws_greengrass"
loggerProperty := &loggerProperty{
component: jsii.String("component"),
id: jsii.String("id"),
level: jsii.String("level"),
type: jsii.String("type"),
// the properties below are optional
space: jsii.Number(123),
}
type CfnLoggerDefinition_LoggerDefinitionVersionProperty ¶
type CfnLoggerDefinition_LoggerDefinitionVersionProperty struct {
// The loggers in this version.
Loggers interface{} `json:"loggers" yaml:"loggers"`
}
A logger definition version contains a list of [loggers](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-loggerdefinition-logger.html) .
> After you create a logger definition version that contains the loggers you want to deploy, you must add it to your group version. For more information, see [`AWS::Greengrass::Group`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html) .
In an AWS CloudFormation template, `LoggerDefinitionVersion` is the property type of the `InitialVersion` property in the [`AWS::Greengrass::LoggerDefinition`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-loggerdefinition.html) resource.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import greengrass "github.com/aws/aws-cdk-go/awscdk/aws_greengrass"
loggerDefinitionVersionProperty := &loggerDefinitionVersionProperty{
loggers: []interface{}{
&loggerProperty{
component: jsii.String("component"),
id: jsii.String("id"),
level: jsii.String("level"),
type: jsii.String("type"),
// the properties below are optional
space: jsii.Number(123),
},
},
}
type CfnLoggerDefinition_LoggerProperty ¶
type CfnLoggerDefinition_LoggerProperty struct {
// The source of the log event.
//
// Valid values are `GreengrassSystem` or `Lambda` . When `GreengrassSystem` is used, events from Greengrass system components are logged. When `Lambda` is used, events from user-defined Lambda functions are logged.
Component *string `json:"component" yaml:"component"`
// A descriptive or arbitrary ID for the logger.
//
// This value must be unique within the logger definition version. Maximum length is 128 characters with pattern `[a-zA-Z0-9:_-]+` .
Id *string `json:"id" yaml:"id"`
// The log-level threshold.
//
// Log events below this threshold are filtered out and aren't stored. Valid values are `DEBUG` , `INFO` (recommended), `WARN` , `ERROR` , or `FATAL` .
Level *string `json:"level" yaml:"level"`
// The storage mechanism for log events.
//
// Valid values are `FileSystem` or `AWSCloudWatch` . When `AWSCloudWatch` is used, log events are sent to CloudWatch Logs . When `FileSystem` is used, log events are stored on the local file system.
Type *string `json:"type" yaml:"type"`
// The amount of file space (in KB) to use when writing logs to the local file system.
//
// This property does not apply for CloudWatch Logs .
Space *float64 `json:"space" yaml:"space"`
}
A logger represents logging settings for the AWS IoT Greengrass group, which can be stored in CloudWatch and the local file system of your core device.
All log entries include a timestamp, log level, and information about the event. For more information, see [Monitoring with AWS IoT Greengrass Logs](https://docs.aws.amazon.com/greengrass/latest/developerguide/greengrass-logs-overview.html) in the *Developer Guide* .
In an AWS CloudFormation template, the `Loggers` property of the [`LoggerDefinitionVersion`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-loggerdefinition-loggerdefinitionversion.html) property type contains a list of `Logger` property types.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import greengrass "github.com/aws/aws-cdk-go/awscdk/aws_greengrass"
loggerProperty := &loggerProperty{
component: jsii.String("component"),
id: jsii.String("id"),
level: jsii.String("level"),
type: jsii.String("type"),
// the properties below are optional
space: jsii.Number(123),
}
type CfnResourceDefinition ¶
type CfnResourceDefinition interface {
awscdk.CfnResource
awscdk.IInspectable
// The Amazon Resource Name (ARN) of the `ResourceDefinition` , such as `arn:aws:greengrass:us-east-1: :/greengrass/definition/resources/1234a5b6-78cd-901e-2fgh-3i45j6k178l9` .
AttrArn() *string
// The ID of the `ResourceDefinition` , such as `1234a5b6-78cd-901e-2fgh-3i45j6k178l9` .
AttrId() *string
// The ARN of the last `ResourceDefinitionVersion` that was added to the `ResourceDefinition` , such as `arn:aws:greengrass:us-east-1: :/greengrass/definition/resources/1234a5b6-78cd-901e-2fgh-3i45j6k178l9/versions/9876ac30-4bdb-4f9d-95af-b5fdb66be1a2` .
AttrLatestVersionArn() *string
// The name of the `ResourceDefinition` , such as `MyResourceDefinition` .
AttrName() *string
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
// Returns: 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.
CreationStack() *[]*string
// The resource definition version to include when the resource definition is created.
//
// A resource definition version contains a list of [`resource instance`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-resourceinstance.html) property types.
//
// > To associate a resource definition version after the resource definition is created, create an [`AWS::Greengrass::ResourceDefinitionVersion`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-resourcedefinitionversion.html) resource and specify the ID of this resource definition.
InitialVersion() interface{}
SetInitialVersion(val interface{})
// 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)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
LogicalId() *string
// The name of the resource definition.
Name() *string
SetName(val *string)
// The tree node.
Node() constructs.Node
// 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 })`.
Ref() *string
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// Application-specific metadata to attach to the resource definition.
//
// You can use tags in IAM policies to control access to AWS IoT Greengrass resources. You can also use tags to categorize your resources. For more information, see [Tagging Your AWS IoT Greengrass Resources](https://docs.aws.amazon.com/greengrass/latest/developerguide/tagging.html) in the *Developer Guide* .
//
// This `Json` property type is processed as a map of key-value pairs. It uses the following format, which is different from most `Tags` implementations in AWS CloudFormation templates.
//
// “`json
// "Tags": { "KeyName0": "value", "KeyName1": "value", "KeyName2": "value"
// }
// “`.
Tags() awscdk.TagManager
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// 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.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// 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.
//
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` 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,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` 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.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
// 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`).
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
// 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.
GetAtt(attributeName *string) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// 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.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::Greengrass::ResourceDefinition`.
The `AWS::Greengrass::ResourceDefinition` resource represents a resource definition for AWS IoT Greengrass . Resource definitions are used to organize your resource definition versions.
Resource definitions can reference multiple resource definition versions. All resource definition versions must be associated with a resource definition. Each resource definition version can contain one or more resources. (In AWS CloudFormation , resources are named *resource instances* .)
> When you create a resource definition, you can optionally include an initial resource definition version. To associate a resource definition version later, create an [`AWS::Greengrass::ResourceDefinitionVersion`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-resourcedefinitionversion.html) resource and specify the ID of this resource definition. > > After you create the resource definition version that contains the resources you want to deploy, you must add it to your group version. For more information, see [`AWS::Greengrass::Group`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html) .
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import greengrass "github.com/aws/aws-cdk-go/awscdk/aws_greengrass"
var tags interface{}
cfnResourceDefinition := greengrass.NewCfnResourceDefinition(this, jsii.String("MyCfnResourceDefinition"), &cfnResourceDefinitionProps{
name: jsii.String("name"),
// the properties below are optional
initialVersion: &resourceDefinitionVersionProperty{
resources: []interface{}{
&resourceInstanceProperty{
id: jsii.String("id"),
name: jsii.String("name"),
resourceDataContainer: &resourceDataContainerProperty{
localDeviceResourceData: &localDeviceResourceDataProperty{
sourcePath: jsii.String("sourcePath"),
// the properties below are optional
groupOwnerSetting: &groupOwnerSettingProperty{
autoAddGroupOwner: jsii.Boolean(false),
// the properties below are optional
groupOwner: jsii.String("groupOwner"),
},
},
localVolumeResourceData: &localVolumeResourceDataProperty{
destinationPath: jsii.String("destinationPath"),
sourcePath: jsii.String("sourcePath"),
// the properties below are optional
groupOwnerSetting: &groupOwnerSettingProperty{
autoAddGroupOwner: jsii.Boolean(false),
// the properties below are optional
groupOwner: jsii.String("groupOwner"),
},
},
s3MachineLearningModelResourceData: &s3MachineLearningModelResourceDataProperty{
destinationPath: jsii.String("destinationPath"),
s3Uri: jsii.String("s3Uri"),
// the properties below are optional
ownerSetting: &resourceDownloadOwnerSettingProperty{
groupOwner: jsii.String("groupOwner"),
groupPermission: jsii.String("groupPermission"),
},
},
sageMakerMachineLearningModelResourceData: &sageMakerMachineLearningModelResourceDataProperty{
destinationPath: jsii.String("destinationPath"),
sageMakerJobArn: jsii.String("sageMakerJobArn"),
// the properties below are optional
ownerSetting: &resourceDownloadOwnerSettingProperty{
groupOwner: jsii.String("groupOwner"),
groupPermission: jsii.String("groupPermission"),
},
},
secretsManagerSecretResourceData: &secretsManagerSecretResourceDataProperty{
arn: jsii.String("arn"),
// the properties below are optional
additionalStagingLabelsToDownload: []*string{
jsii.String("additionalStagingLabelsToDownload"),
},
},
},
},
},
},
tags: tags,
})
func NewCfnResourceDefinition ¶
func NewCfnResourceDefinition(scope constructs.Construct, id *string, props *CfnResourceDefinitionProps) CfnResourceDefinition
Create a new `AWS::Greengrass::ResourceDefinition`.
type CfnResourceDefinitionProps ¶
type CfnResourceDefinitionProps struct {
// The name of the resource definition.
Name *string `json:"name" yaml:"name"`
// The resource definition version to include when the resource definition is created.
//
// A resource definition version contains a list of [`resource instance`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-resourceinstance.html) property types.
//
// > To associate a resource definition version after the resource definition is created, create an [`AWS::Greengrass::ResourceDefinitionVersion`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-resourcedefinitionversion.html) resource and specify the ID of this resource definition.
InitialVersion interface{} `json:"initialVersion" yaml:"initialVersion"`
// Application-specific metadata to attach to the resource definition.
//
// You can use tags in IAM policies to control access to AWS IoT Greengrass resources. You can also use tags to categorize your resources. For more information, see [Tagging Your AWS IoT Greengrass Resources](https://docs.aws.amazon.com/greengrass/latest/developerguide/tagging.html) in the *Developer Guide* .
//
// This `Json` property type is processed as a map of key-value pairs. It uses the following format, which is different from most `Tags` implementations in AWS CloudFormation templates.
//
// “`json
// "Tags": { "KeyName0": "value", "KeyName1": "value", "KeyName2": "value"
// }
// “`.
Tags interface{} `json:"tags" yaml:"tags"`
}
Properties for defining a `CfnResourceDefinition`.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import greengrass "github.com/aws/aws-cdk-go/awscdk/aws_greengrass"
var tags interface{}
cfnResourceDefinitionProps := &cfnResourceDefinitionProps{
name: jsii.String("name"),
// the properties below are optional
initialVersion: &resourceDefinitionVersionProperty{
resources: []interface{}{
&resourceInstanceProperty{
id: jsii.String("id"),
name: jsii.String("name"),
resourceDataContainer: &resourceDataContainerProperty{
localDeviceResourceData: &localDeviceResourceDataProperty{
sourcePath: jsii.String("sourcePath"),
// the properties below are optional
groupOwnerSetting: &groupOwnerSettingProperty{
autoAddGroupOwner: jsii.Boolean(false),
// the properties below are optional
groupOwner: jsii.String("groupOwner"),
},
},
localVolumeResourceData: &localVolumeResourceDataProperty{
destinationPath: jsii.String("destinationPath"),
sourcePath: jsii.String("sourcePath"),
// the properties below are optional
groupOwnerSetting: &groupOwnerSettingProperty{
autoAddGroupOwner: jsii.Boolean(false),
// the properties below are optional
groupOwner: jsii.String("groupOwner"),
},
},
s3MachineLearningModelResourceData: &s3MachineLearningModelResourceDataProperty{
destinationPath: jsii.String("destinationPath"),
s3Uri: jsii.String("s3Uri"),
// the properties below are optional
ownerSetting: &resourceDownloadOwnerSettingProperty{
groupOwner: jsii.String("groupOwner"),
groupPermission: jsii.String("groupPermission"),
},
},
sageMakerMachineLearningModelResourceData: &sageMakerMachineLearningModelResourceDataProperty{
destinationPath: jsii.String("destinationPath"),
sageMakerJobArn: jsii.String("sageMakerJobArn"),
// the properties below are optional
ownerSetting: &resourceDownloadOwnerSettingProperty{
groupOwner: jsii.String("groupOwner"),
groupPermission: jsii.String("groupPermission"),
},
},
secretsManagerSecretResourceData: &secretsManagerSecretResourceDataProperty{
arn: jsii.String("arn"),
// the properties below are optional
additionalStagingLabelsToDownload: []*string{
jsii.String("additionalStagingLabelsToDownload"),
},
},
},
},
},
},
tags: tags,
}
type CfnResourceDefinitionVersion ¶
type CfnResourceDefinitionVersion interface {
awscdk.CfnResource
awscdk.IInspectable
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
// Returns: 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.
CreationStack() *[]*string
// 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)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
LogicalId() *string
// The tree node.
Node() constructs.Node
// 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 })`.
Ref() *string
// The ID of the resource definition associated with this version.
//
// This value is a GUID.
ResourceDefinitionId() *string
SetResourceDefinitionId(val *string)
// The resources in this version.
Resources() interface{}
SetResources(val interface{})
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// 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.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// 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.
//
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` 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,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` 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.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
// 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`).
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
// 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.
GetAtt(attributeName *string) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// 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.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::Greengrass::ResourceDefinitionVersion`.
The `AWS::Greengrass::ResourceDefinitionVersion` resource represents a resource definition version for AWS IoT Greengrass . A resource definition version contains a list of resources. (In AWS CloudFormation , resources are named *resource instances* .)
> To create a resource definition version, you must specify the ID of the resource definition that you want to associate with the version. For information about creating a resource definition, see [`AWS::Greengrass::ResourceDefinition`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-resourcedefinition.html) . > > After you create a resource definition version that contains the resources you want to deploy, you must add it to your group version. For more information, see [`AWS::Greengrass::Group`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html) .
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import greengrass "github.com/aws/aws-cdk-go/awscdk/aws_greengrass"
cfnResourceDefinitionVersion := greengrass.NewCfnResourceDefinitionVersion(this, jsii.String("MyCfnResourceDefinitionVersion"), &cfnResourceDefinitionVersionProps{
resourceDefinitionId: jsii.String("resourceDefinitionId"),
resources: []interface{}{
&resourceInstanceProperty{
id: jsii.String("id"),
name: jsii.String("name"),
resourceDataContainer: &resourceDataContainerProperty{
localDeviceResourceData: &localDeviceResourceDataProperty{
sourcePath: jsii.String("sourcePath"),
// the properties below are optional
groupOwnerSetting: &groupOwnerSettingProperty{
autoAddGroupOwner: jsii.Boolean(false),
// the properties below are optional
groupOwner: jsii.String("groupOwner"),
},
},
localVolumeResourceData: &localVolumeResourceDataProperty{
destinationPath: jsii.String("destinationPath"),
sourcePath: jsii.String("sourcePath"),
// the properties below are optional
groupOwnerSetting: &groupOwnerSettingProperty{
autoAddGroupOwner: jsii.Boolean(false),
// the properties below are optional
groupOwner: jsii.String("groupOwner"),
},
},
s3MachineLearningModelResourceData: &s3MachineLearningModelResourceDataProperty{
destinationPath: jsii.String("destinationPath"),
s3Uri: jsii.String("s3Uri"),
// the properties below are optional
ownerSetting: &resourceDownloadOwnerSettingProperty{
groupOwner: jsii.String("groupOwner"),
groupPermission: jsii.String("groupPermission"),
},
},
sageMakerMachineLearningModelResourceData: &sageMakerMachineLearningModelResourceDataProperty{
destinationPath: jsii.String("destinationPath"),
sageMakerJobArn: jsii.String("sageMakerJobArn"),
// the properties below are optional
ownerSetting: &resourceDownloadOwnerSettingProperty{
groupOwner: jsii.String("groupOwner"),
groupPermission: jsii.String("groupPermission"),
},
},
secretsManagerSecretResourceData: &secretsManagerSecretResourceDataProperty{
arn: jsii.String("arn"),
// the properties below are optional
additionalStagingLabelsToDownload: []*string{
jsii.String("additionalStagingLabelsToDownload"),
},
},
},
},
},
})
func NewCfnResourceDefinitionVersion ¶
func NewCfnResourceDefinitionVersion(scope constructs.Construct, id *string, props *CfnResourceDefinitionVersionProps) CfnResourceDefinitionVersion
Create a new `AWS::Greengrass::ResourceDefinitionVersion`.
type CfnResourceDefinitionVersionProps ¶
type CfnResourceDefinitionVersionProps struct {
// The ID of the resource definition associated with this version.
//
// This value is a GUID.
ResourceDefinitionId *string `json:"resourceDefinitionId" yaml:"resourceDefinitionId"`
// The resources in this version.
Resources interface{} `json:"resources" yaml:"resources"`
}
Properties for defining a `CfnResourceDefinitionVersion`.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import greengrass "github.com/aws/aws-cdk-go/awscdk/aws_greengrass"
cfnResourceDefinitionVersionProps := &cfnResourceDefinitionVersionProps{
resourceDefinitionId: jsii.String("resourceDefinitionId"),
resources: []interface{}{
&resourceInstanceProperty{
id: jsii.String("id"),
name: jsii.String("name"),
resourceDataContainer: &resourceDataContainerProperty{
localDeviceResourceData: &localDeviceResourceDataProperty{
sourcePath: jsii.String("sourcePath"),
// the properties below are optional
groupOwnerSetting: &groupOwnerSettingProperty{
autoAddGroupOwner: jsii.Boolean(false),
// the properties below are optional
groupOwner: jsii.String("groupOwner"),
},
},
localVolumeResourceData: &localVolumeResourceDataProperty{
destinationPath: jsii.String("destinationPath"),
sourcePath: jsii.String("sourcePath"),
// the properties below are optional
groupOwnerSetting: &groupOwnerSettingProperty{
autoAddGroupOwner: jsii.Boolean(false),
// the properties below are optional
groupOwner: jsii.String("groupOwner"),
},
},
s3MachineLearningModelResourceData: &s3MachineLearningModelResourceDataProperty{
destinationPath: jsii.String("destinationPath"),
s3Uri: jsii.String("s3Uri"),
// the properties below are optional
ownerSetting: &resourceDownloadOwnerSettingProperty{
groupOwner: jsii.String("groupOwner"),
groupPermission: jsii.String("groupPermission"),
},
},
sageMakerMachineLearningModelResourceData: &sageMakerMachineLearningModelResourceDataProperty{
destinationPath: jsii.String("destinationPath"),
sageMakerJobArn: jsii.String("sageMakerJobArn"),
// the properties below are optional
ownerSetting: &resourceDownloadOwnerSettingProperty{
groupOwner: jsii.String("groupOwner"),
groupPermission: jsii.String("groupPermission"),
},
},
secretsManagerSecretResourceData: &secretsManagerSecretResourceDataProperty{
arn: jsii.String("arn"),
// the properties below are optional
additionalStagingLabelsToDownload: []*string{
jsii.String("additionalStagingLabelsToDownload"),
},
},
},
},
},
}
type CfnResourceDefinitionVersion_GroupOwnerSettingProperty ¶
type CfnResourceDefinitionVersion_GroupOwnerSettingProperty struct {
// Indicates whether to give the privileges of the Linux group that owns the resource to the Lambda process.
//
// This gives the Lambda process the file access permissions of the Linux group.
AutoAddGroupOwner interface{} `json:"autoAddGroupOwner" yaml:"autoAddGroupOwner"`
// The name of the Linux group whose privileges you want to add to the Lambda process.
//
// This value is ignored if `AutoAddGroupOwner` is true.
GroupOwner *string `json:"groupOwner" yaml:"groupOwner"`
}
Settings that define additional Linux OS group permissions to give to the Lambda function process.
You can give the permissions of the Linux group that owns the resource or choose another Linux group. These permissions are in addition to the function's `RunAs` permissions.
In an AWS CloudFormation template, `GroupOwnerSetting` is a property of the [`LocalDeviceResourceData`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-localdeviceresourcedata.html) and [`LocalVolumeResourceData`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-localvolumeresourcedata.html) property types.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import greengrass "github.com/aws/aws-cdk-go/awscdk/aws_greengrass"
groupOwnerSettingProperty := &groupOwnerSettingProperty{
autoAddGroupOwner: jsii.Boolean(false),
// the properties below are optional
groupOwner: jsii.String("groupOwner"),
}
type CfnResourceDefinitionVersion_LocalDeviceResourceDataProperty ¶
type CfnResourceDefinitionVersion_LocalDeviceResourceDataProperty struct {
// The local absolute path of the device resource.
//
// The source path for a device resource can refer only to a character device or block device under `/dev` .
SourcePath *string `json:"sourcePath" yaml:"sourcePath"`
// Settings that define additional Linux OS group permissions to give to the Lambda function process.
GroupOwnerSetting interface{} `json:"groupOwnerSetting" yaml:"groupOwnerSetting"`
}
Settings for a local device resource, which represents a file under `/dev` .
For more information, see [Access Local Resources with Lambda Functions](https://docs.aws.amazon.com/greengrass/latest/developerguide/access-local-resources.html) in the *Developer Guide* .
In an AWS CloudFormation template, `LocalDeviceResourceData` can be used in the [`ResourceDataContainer`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-resourcedatacontainer.html) property type.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import greengrass "github.com/aws/aws-cdk-go/awscdk/aws_greengrass"
localDeviceResourceDataProperty := &localDeviceResourceDataProperty{
sourcePath: jsii.String("sourcePath"),
// the properties below are optional
groupOwnerSetting: &groupOwnerSettingProperty{
autoAddGroupOwner: jsii.Boolean(false),
// the properties below are optional
groupOwner: jsii.String("groupOwner"),
},
}
type CfnResourceDefinitionVersion_LocalVolumeResourceDataProperty ¶
type CfnResourceDefinitionVersion_LocalVolumeResourceDataProperty struct {
// The absolute local path of the resource in the Lambda environment.
DestinationPath *string `json:"destinationPath" yaml:"destinationPath"`
// The local absolute path of the volume resource on the host.
//
// The source path for a volume resource type cannot start with `/sys` .
SourcePath *string `json:"sourcePath" yaml:"sourcePath"`
// Settings that define additional Linux OS group permissions to give to the Lambda function process.
GroupOwnerSetting interface{} `json:"groupOwnerSetting" yaml:"groupOwnerSetting"`
}
Settings for a local volume resource, which represents a file or directory on the root file system.
For more information, see [Access Local Resources with Lambda Functions](https://docs.aws.amazon.com/greengrass/latest/developerguide/access-local-resources.html) in the *Developer Guide* .
In an AWS CloudFormation template, `LocalVolumeResourceData` can be used in the [`ResourceDataContainer`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-resourcedatacontainer.html) property type.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import greengrass "github.com/aws/aws-cdk-go/awscdk/aws_greengrass"
localVolumeResourceDataProperty := &localVolumeResourceDataProperty{
destinationPath: jsii.String("destinationPath"),
sourcePath: jsii.String("sourcePath"),
// the properties below are optional
groupOwnerSetting: &groupOwnerSettingProperty{
autoAddGroupOwner: jsii.Boolean(false),
// the properties below are optional
groupOwner: jsii.String("groupOwner"),
},
}
type CfnResourceDefinitionVersion_ResourceDataContainerProperty ¶
type CfnResourceDefinitionVersion_ResourceDataContainerProperty struct {
// Settings for a local device resource.
LocalDeviceResourceData interface{} `json:"localDeviceResourceData" yaml:"localDeviceResourceData"`
// Settings for a local volume resource.
LocalVolumeResourceData interface{} `json:"localVolumeResourceData" yaml:"localVolumeResourceData"`
// Settings for a machine learning resource stored in Amazon S3 .
S3MachineLearningModelResourceData interface{} `json:"s3MachineLearningModelResourceData" yaml:"s3MachineLearningModelResourceData"`
// Settings for a machine learning resource saved as an SageMaker training job.
SageMakerMachineLearningModelResourceData interface{} `json:"sageMakerMachineLearningModelResourceData" yaml:"sageMakerMachineLearningModelResourceData"`
// Settings for a secret resource.
SecretsManagerSecretResourceData interface{} `json:"secretsManagerSecretResourceData" yaml:"secretsManagerSecretResourceData"`
}
A container for resource data, which defines the resource type.
The container takes only one of the following supported resource data types: `LocalDeviceResourceData` , `LocalVolumeResourceData` , `SageMakerMachineLearningModelResourceData` , `S3MachineLearningModelResourceData` , or `SecretsManagerSecretResourceData` .
> Only one resource type can be defined for a `ResourceDataContainer` instance.
In an AWS CloudFormation template, `ResourceDataContainer` is a property of the [`ResourceInstance`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-resourceinstance.html) property type.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import greengrass "github.com/aws/aws-cdk-go/awscdk/aws_greengrass"
resourceDataContainerProperty := &resourceDataContainerProperty{
localDeviceResourceData: &localDeviceResourceDataProperty{
sourcePath: jsii.String("sourcePath"),
// the properties below are optional
groupOwnerSetting: &groupOwnerSettingProperty{
autoAddGroupOwner: jsii.Boolean(false),
// the properties below are optional
groupOwner: jsii.String("groupOwner"),
},
},
localVolumeResourceData: &localVolumeResourceDataProperty{
destinationPath: jsii.String("destinationPath"),
sourcePath: jsii.String("sourcePath"),
// the properties below are optional
groupOwnerSetting: &groupOwnerSettingProperty{
autoAddGroupOwner: jsii.Boolean(false),
// the properties below are optional
groupOwner: jsii.String("groupOwner"),
},
},
s3MachineLearningModelResourceData: &s3MachineLearningModelResourceDataProperty{
destinationPath: jsii.String("destinationPath"),
s3Uri: jsii.String("s3Uri"),
// the properties below are optional
ownerSetting: &resourceDownloadOwnerSettingProperty{
groupOwner: jsii.String("groupOwner"),
groupPermission: jsii.String("groupPermission"),
},
},
sageMakerMachineLearningModelResourceData: &sageMakerMachineLearningModelResourceDataProperty{
destinationPath: jsii.String("destinationPath"),
sageMakerJobArn: jsii.String("sageMakerJobArn"),
// the properties below are optional
ownerSetting: &resourceDownloadOwnerSettingProperty{
groupOwner: jsii.String("groupOwner"),
groupPermission: jsii.String("groupPermission"),
},
},
secretsManagerSecretResourceData: &secretsManagerSecretResourceDataProperty{
arn: jsii.String("arn"),
// the properties below are optional
additionalStagingLabelsToDownload: []*string{
jsii.String("additionalStagingLabelsToDownload"),
},
},
}
type CfnResourceDefinitionVersion_ResourceDownloadOwnerSettingProperty ¶
type CfnResourceDefinitionVersion_ResourceDownloadOwnerSettingProperty struct {
// The group owner of the machine learning resource.
//
// This is the group ID (GID) of an existing Linux OS group on the system. The group's permissions are added to the Lambda process.
GroupOwner *string `json:"groupOwner" yaml:"groupOwner"`
// The permissions that the group owner has to the machine learning resource.
//
// Valid values are `rw` (read-write) or `ro` (read-only).
GroupPermission *string `json:"groupPermission" yaml:"groupPermission"`
}
The owner setting for a downloaded machine learning resource.
For more information, see [Access Machine Learning Resources from Lambda Functions](https://docs.aws.amazon.com/greengrass/latest/developerguide/access-ml-resources.html) in the *Developer Guide* .
In an AWS CloudFormation template, `ResourceDownloadOwnerSetting` is the property type of the `OwnerSetting` property for the [`S3MachineLearningModelResourceData`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-s3machinelearningmodelresourcedata.html) and [`SageMakerMachineLearningModelResourceData`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-sagemakermachinelearningmodelresourcedata.html) property types.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import greengrass "github.com/aws/aws-cdk-go/awscdk/aws_greengrass"
resourceDownloadOwnerSettingProperty := &resourceDownloadOwnerSettingProperty{
groupOwner: jsii.String("groupOwner"),
groupPermission: jsii.String("groupPermission"),
}
type CfnResourceDefinitionVersion_ResourceInstanceProperty ¶
type CfnResourceDefinitionVersion_ResourceInstanceProperty struct {
// A descriptive or arbitrary ID for the resource.
//
// This value must be unique within the resource definition version. Maximum length is 128 characters with pattern `[a-zA-Z0-9:_-]+` .
Id *string `json:"id" yaml:"id"`
// The descriptive resource name, which is displayed on the AWS IoT Greengrass console.
//
// Maximum length 128 characters with pattern [a-zA-Z0-9:_-]+. This must be unique within a Greengrass group.
Name *string `json:"name" yaml:"name"`
// A container for resource data.
//
// The container takes only one of the following supported resource data types: `LocalDeviceResourceData` , `LocalVolumeResourceData` , `SageMakerMachineLearningModelResourceData` , `S3MachineLearningModelResourceData` , or `SecretsManagerSecretResourceData` .
//
// > Only one resource type can be defined for a `ResourceDataContainer` instance.
ResourceDataContainer interface{} `json:"resourceDataContainer" yaml:"resourceDataContainer"`
}
A local resource, machine learning resource, or secret resource.
For more information, see [Access Local Resources with Lambda Functions](https://docs.aws.amazon.com/greengrass/latest/developerguide/access-local-resources.html) , [Perform Machine Learning Inference](https://docs.aws.amazon.com/greengrass/latest/developerguide/ml-inference.html) , and [Deploy Secrets to the AWS IoT Greengrass Core](https://docs.aws.amazon.com/greengrass/latest/developerguide/secrets.html) in the *Developer Guide* .
In an AWS CloudFormation template, the `Resources` property of the [`AWS::Greengrass::ResourceDefinitionVersion`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-resourcedefinitionversion.html) resource contains a list of `ResourceInstance` property types.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import greengrass "github.com/aws/aws-cdk-go/awscdk/aws_greengrass"
resourceInstanceProperty := &resourceInstanceProperty{
id: jsii.String("id"),
name: jsii.String("name"),
resourceDataContainer: &resourceDataContainerProperty{
localDeviceResourceData: &localDeviceResourceDataProperty{
sourcePath: jsii.String("sourcePath"),
// the properties below are optional
groupOwnerSetting: &groupOwnerSettingProperty{
autoAddGroupOwner: jsii.Boolean(false),
// the properties below are optional
groupOwner: jsii.String("groupOwner"),
},
},
localVolumeResourceData: &localVolumeResourceDataProperty{
destinationPath: jsii.String("destinationPath"),
sourcePath: jsii.String("sourcePath"),
// the properties below are optional
groupOwnerSetting: &groupOwnerSettingProperty{
autoAddGroupOwner: jsii.Boolean(false),
// the properties below are optional
groupOwner: jsii.String("groupOwner"),
},
},
s3MachineLearningModelResourceData: &s3MachineLearningModelResourceDataProperty{
destinationPath: jsii.String("destinationPath"),
s3Uri: jsii.String("s3Uri"),
// the properties below are optional
ownerSetting: &resourceDownloadOwnerSettingProperty{
groupOwner: jsii.String("groupOwner"),
groupPermission: jsii.String("groupPermission"),
},
},
sageMakerMachineLearningModelResourceData: &sageMakerMachineLearningModelResourceDataProperty{
destinationPath: jsii.String("destinationPath"),
sageMakerJobArn: jsii.String("sageMakerJobArn"),
// the properties below are optional
ownerSetting: &resourceDownloadOwnerSettingProperty{
groupOwner: jsii.String("groupOwner"),
groupPermission: jsii.String("groupPermission"),
},
},
secretsManagerSecretResourceData: &secretsManagerSecretResourceDataProperty{
arn: jsii.String("arn"),
// the properties below are optional
additionalStagingLabelsToDownload: []*string{
jsii.String("additionalStagingLabelsToDownload"),
},
},
},
}
type CfnResourceDefinitionVersion_S3MachineLearningModelResourceDataProperty ¶
type CfnResourceDefinitionVersion_S3MachineLearningModelResourceDataProperty struct {
// The absolute local path of the resource inside the Lambda environment.
DestinationPath *string `json:"destinationPath" yaml:"destinationPath"`
// The URI of the source model in an Amazon S3 bucket.
//
// The model package must be in `tar.gz` or `.zip` format.
S3Uri *string `json:"s3Uri" yaml:"s3Uri"`
// The owner setting for the downloaded machine learning resource.
//
// For more information, see [Access Machine Learning Resources from Lambda Functions](https://docs.aws.amazon.com/greengrass/latest/developerguide/access-ml-resources.html) in the *Developer Guide* .
OwnerSetting interface{} `json:"ownerSetting" yaml:"ownerSetting"`
}
Settings for an Amazon S3 machine learning resource.
For more information, see [Perform Machine Learning Inference](https://docs.aws.amazon.com/greengrass/latest/developerguide/ml-inference.html) in the *Developer Guide* .
In an AWS CloudFormation template, `S3MachineLearningModelResourceData` can be used in the [`ResourceDataContainer`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-resourcedatacontainer.html) property type.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import greengrass "github.com/aws/aws-cdk-go/awscdk/aws_greengrass"
s3MachineLearningModelResourceDataProperty := &s3MachineLearningModelResourceDataProperty{
destinationPath: jsii.String("destinationPath"),
s3Uri: jsii.String("s3Uri"),
// the properties below are optional
ownerSetting: &resourceDownloadOwnerSettingProperty{
groupOwner: jsii.String("groupOwner"),
groupPermission: jsii.String("groupPermission"),
},
}
type CfnResourceDefinitionVersion_SageMakerMachineLearningModelResourceDataProperty ¶
type CfnResourceDefinitionVersion_SageMakerMachineLearningModelResourceDataProperty struct {
// The absolute local path of the resource inside the Lambda environment.
DestinationPath *string `json:"destinationPath" yaml:"destinationPath"`
// The Amazon Resource Name (ARN) of the Amazon SageMaker training job that represents the source model.
SageMakerJobArn *string `json:"sageMakerJobArn" yaml:"sageMakerJobArn"`
// The owner setting for the downloaded machine learning resource.
//
// For more information, see [Access Machine Learning Resources from Lambda Functions](https://docs.aws.amazon.com/greengrass/latest/developerguide/access-ml-resources.html) in the *Developer Guide* .
OwnerSetting interface{} `json:"ownerSetting" yaml:"ownerSetting"`
}
Settings for an Secrets Manager machine learning resource.
For more information, see [Perform Machine Learning Inference](https://docs.aws.amazon.com/greengrass/latest/developerguide/ml-inference.html) in the *Developer Guide* .
In an AWS CloudFormation template, `SageMakerMachineLearningModelResourceData` can be used in the [`ResourceDataContainer`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-resourcedatacontainer.html) property type.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import greengrass "github.com/aws/aws-cdk-go/awscdk/aws_greengrass"
sageMakerMachineLearningModelResourceDataProperty := &sageMakerMachineLearningModelResourceDataProperty{
destinationPath: jsii.String("destinationPath"),
sageMakerJobArn: jsii.String("sageMakerJobArn"),
// the properties below are optional
ownerSetting: &resourceDownloadOwnerSettingProperty{
groupOwner: jsii.String("groupOwner"),
groupPermission: jsii.String("groupPermission"),
},
}
type CfnResourceDefinitionVersion_SecretsManagerSecretResourceDataProperty ¶
type CfnResourceDefinitionVersion_SecretsManagerSecretResourceDataProperty struct {
// The Amazon Resource Name (ARN) of the Secrets Manager secret to make available on the core.
//
// The value of the secret's latest version (represented by the `AWSCURRENT` staging label) is included by default.
Arn *string `json:"arn" yaml:"arn"`
// The staging labels whose values you want to make available on the core, in addition to `AWSCURRENT` .
AdditionalStagingLabelsToDownload *[]*string `json:"additionalStagingLabelsToDownload" yaml:"additionalStagingLabelsToDownload"`
}
Settings for a secret resource, which references a secret from AWS Secrets Manager .
AWS IoT Greengrass stores a local, encrypted copy of the secret on the Greengrass core, where it can be securely accessed by connectors and Lambda functions. For more information, see [Deploy Secrets to the AWS IoT Greengrass Core](https://docs.aws.amazon.com/greengrass/latest/developerguide/secrets.html) in the *Developer Guide* .
In an AWS CloudFormation template, `SecretsManagerSecretResourceData` can be used in the [`ResourceDataContainer`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-resourcedatacontainer.html) property type.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import greengrass "github.com/aws/aws-cdk-go/awscdk/aws_greengrass"
secretsManagerSecretResourceDataProperty := &secretsManagerSecretResourceDataProperty{
arn: jsii.String("arn"),
// the properties below are optional
additionalStagingLabelsToDownload: []*string{
jsii.String("additionalStagingLabelsToDownload"),
},
}
type CfnResourceDefinition_GroupOwnerSettingProperty ¶
type CfnResourceDefinition_GroupOwnerSettingProperty struct {
// Indicates whether to give the privileges of the Linux group that owns the resource to the Lambda process.
//
// This gives the Lambda process the file access permissions of the Linux group.
AutoAddGroupOwner interface{} `json:"autoAddGroupOwner" yaml:"autoAddGroupOwner"`
// The name of the Linux group whose privileges you want to add to the Lambda process.
//
// This value is ignored if `AutoAddGroupOwner` is true.
GroupOwner *string `json:"groupOwner" yaml:"groupOwner"`
}
Settings that define additional Linux OS group permissions to give to the Lambda function process.
You can give the permissions of the Linux group that owns the resource or choose another Linux group. These permissions are in addition to the function's `RunAs` permissions.
In an AWS CloudFormation template, `GroupOwnerSetting` is a property of the [`LocalDeviceResourceData`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-localdeviceresourcedata.html) and [`LocalVolumeResourceData`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-localvolumeresourcedata.html) property types.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import greengrass "github.com/aws/aws-cdk-go/awscdk/aws_greengrass"
groupOwnerSettingProperty := &groupOwnerSettingProperty{
autoAddGroupOwner: jsii.Boolean(false),
// the properties below are optional
groupOwner: jsii.String("groupOwner"),
}
type CfnResourceDefinition_LocalDeviceResourceDataProperty ¶
type CfnResourceDefinition_LocalDeviceResourceDataProperty struct {
// The local absolute path of the device resource.
//
// The source path for a device resource can refer only to a character device or block device under `/dev` .
SourcePath *string `json:"sourcePath" yaml:"sourcePath"`
// Settings that define additional Linux OS group permissions to give to the Lambda function process.
GroupOwnerSetting interface{} `json:"groupOwnerSetting" yaml:"groupOwnerSetting"`
}
Settings for a local device resource, which represents a file under `/dev` .
For more information, see [Access Local Resources with Lambda Functions](https://docs.aws.amazon.com/greengrass/latest/developerguide/access-local-resources.html) in the *Developer Guide* .
In an AWS CloudFormation template, `LocalDeviceResourceData` can be used in the [`ResourceDataContainer`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-resourcedatacontainer.html) property type.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import greengrass "github.com/aws/aws-cdk-go/awscdk/aws_greengrass"
localDeviceResourceDataProperty := &localDeviceResourceDataProperty{
sourcePath: jsii.String("sourcePath"),
// the properties below are optional
groupOwnerSetting: &groupOwnerSettingProperty{
autoAddGroupOwner: jsii.Boolean(false),
// the properties below are optional
groupOwner: jsii.String("groupOwner"),
},
}
type CfnResourceDefinition_LocalVolumeResourceDataProperty ¶
type CfnResourceDefinition_LocalVolumeResourceDataProperty struct {
// The absolute local path of the resource in the Lambda environment.
DestinationPath *string `json:"destinationPath" yaml:"destinationPath"`
// The local absolute path of the volume resource on the host.
//
// The source path for a volume resource type cannot start with `/sys` .
SourcePath *string `json:"sourcePath" yaml:"sourcePath"`
// Settings that define additional Linux OS group permissions to give to the Lambda function process.
GroupOwnerSetting interface{} `json:"groupOwnerSetting" yaml:"groupOwnerSetting"`
}
Settings for a local volume resource, which represents a file or directory on the root file system.
For more information, see [Access Local Resources with Lambda Functions](https://docs.aws.amazon.com/greengrass/latest/developerguide/access-local-resources.html) in the *Developer Guide* .
In an AWS CloudFormation template, `LocalVolumeResourceData` can be used in the [`ResourceDataContainer`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-resourcedatacontainer.html) property type.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import greengrass "github.com/aws/aws-cdk-go/awscdk/aws_greengrass"
localVolumeResourceDataProperty := &localVolumeResourceDataProperty{
destinationPath: jsii.String("destinationPath"),
sourcePath: jsii.String("sourcePath"),
// the properties below are optional
groupOwnerSetting: &groupOwnerSettingProperty{
autoAddGroupOwner: jsii.Boolean(false),
// the properties below are optional
groupOwner: jsii.String("groupOwner"),
},
}
type CfnResourceDefinition_ResourceDataContainerProperty ¶
type CfnResourceDefinition_ResourceDataContainerProperty struct {
// Settings for a local device resource.
LocalDeviceResourceData interface{} `json:"localDeviceResourceData" yaml:"localDeviceResourceData"`
// Settings for a local volume resource.
LocalVolumeResourceData interface{} `json:"localVolumeResourceData" yaml:"localVolumeResourceData"`
// Settings for a machine learning resource stored in Amazon S3 .
S3MachineLearningModelResourceData interface{} `json:"s3MachineLearningModelResourceData" yaml:"s3MachineLearningModelResourceData"`
// Settings for a machine learning resource saved as an SageMaker training job.
SageMakerMachineLearningModelResourceData interface{} `json:"sageMakerMachineLearningModelResourceData" yaml:"sageMakerMachineLearningModelResourceData"`
// Settings for a secret resource.
SecretsManagerSecretResourceData interface{} `json:"secretsManagerSecretResourceData" yaml:"secretsManagerSecretResourceData"`
}
A container for resource data, which defines the resource type.
The container takes only one of the following supported resource data types: `LocalDeviceResourceData` , `LocalVolumeResourceData` , `SageMakerMachineLearningModelResourceData` , `S3MachineLearningModelResourceData` , or `SecretsManagerSecretResourceData` .
> Only one resource type can be defined for a `ResourceDataContainer` instance.
In an AWS CloudFormation template, `ResourceDataContainer` is a property of the [`ResourceInstance`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-resourceinstance.html) property type.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import greengrass "github.com/aws/aws-cdk-go/awscdk/aws_greengrass"
resourceDataContainerProperty := &resourceDataContainerProperty{
localDeviceResourceData: &localDeviceResourceDataProperty{
sourcePath: jsii.String("sourcePath"),
// the properties below are optional
groupOwnerSetting: &groupOwnerSettingProperty{
autoAddGroupOwner: jsii.Boolean(false),
// the properties below are optional
groupOwner: jsii.String("groupOwner"),
},
},
localVolumeResourceData: &localVolumeResourceDataProperty{
destinationPath: jsii.String("destinationPath"),
sourcePath: jsii.String("sourcePath"),
// the properties below are optional
groupOwnerSetting: &groupOwnerSettingProperty{
autoAddGroupOwner: jsii.Boolean(false),
// the properties below are optional
groupOwner: jsii.String("groupOwner"),
},
},
s3MachineLearningModelResourceData: &s3MachineLearningModelResourceDataProperty{
destinationPath: jsii.String("destinationPath"),
s3Uri: jsii.String("s3Uri"),
// the properties below are optional
ownerSetting: &resourceDownloadOwnerSettingProperty{
groupOwner: jsii.String("groupOwner"),
groupPermission: jsii.String("groupPermission"),
},
},
sageMakerMachineLearningModelResourceData: &sageMakerMachineLearningModelResourceDataProperty{
destinationPath: jsii.String("destinationPath"),
sageMakerJobArn: jsii.String("sageMakerJobArn"),
// the properties below are optional
ownerSetting: &resourceDownloadOwnerSettingProperty{
groupOwner: jsii.String("groupOwner"),
groupPermission: jsii.String("groupPermission"),
},
},
secretsManagerSecretResourceData: &secretsManagerSecretResourceDataProperty{
arn: jsii.String("arn"),
// the properties below are optional
additionalStagingLabelsToDownload: []*string{
jsii.String("additionalStagingLabelsToDownload"),
},
},
}
type CfnResourceDefinition_ResourceDefinitionVersionProperty ¶
type CfnResourceDefinition_ResourceDefinitionVersionProperty struct {
// The resources in this version.
Resources interface{} `json:"resources" yaml:"resources"`
}
A resource definition version contains a list of resources. (In AWS CloudFormation , resources are named *resource instances* .).
> After you create a resource definition version that contains the resources you want to deploy, you must add it to your group version. For more information, see [`AWS::Greengrass::Group`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html) .
In an AWS CloudFormation template, `ResourceDefinitionVersion` is the property type of the `InitialVersion` property in the [`AWS::Greengrass::ResourceDefinition`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-resourcedefinition.html) resource.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import greengrass "github.com/aws/aws-cdk-go/awscdk/aws_greengrass"
resourceDefinitionVersionProperty := &resourceDefinitionVersionProperty{
resources: []interface{}{
&resourceInstanceProperty{
id: jsii.String("id"),
name: jsii.String("name"),
resourceDataContainer: &resourceDataContainerProperty{
localDeviceResourceData: &localDeviceResourceDataProperty{
sourcePath: jsii.String("sourcePath"),
// the properties below are optional
groupOwnerSetting: &groupOwnerSettingProperty{
autoAddGroupOwner: jsii.Boolean(false),
// the properties below are optional
groupOwner: jsii.String("groupOwner"),
},
},
localVolumeResourceData: &localVolumeResourceDataProperty{
destinationPath: jsii.String("destinationPath"),
sourcePath: jsii.String("sourcePath"),
// the properties below are optional
groupOwnerSetting: &groupOwnerSettingProperty{
autoAddGroupOwner: jsii.Boolean(false),
// the properties below are optional
groupOwner: jsii.String("groupOwner"),
},
},
s3MachineLearningModelResourceData: &s3MachineLearningModelResourceDataProperty{
destinationPath: jsii.String("destinationPath"),
s3Uri: jsii.String("s3Uri"),
// the properties below are optional
ownerSetting: &resourceDownloadOwnerSettingProperty{
groupOwner: jsii.String("groupOwner"),
groupPermission: jsii.String("groupPermission"),
},
},
sageMakerMachineLearningModelResourceData: &sageMakerMachineLearningModelResourceDataProperty{
destinationPath: jsii.String("destinationPath"),
sageMakerJobArn: jsii.String("sageMakerJobArn"),
// the properties below are optional
ownerSetting: &resourceDownloadOwnerSettingProperty{
groupOwner: jsii.String("groupOwner"),
groupPermission: jsii.String("groupPermission"),
},
},
secretsManagerSecretResourceData: &secretsManagerSecretResourceDataProperty{
arn: jsii.String("arn"),
// the properties below are optional
additionalStagingLabelsToDownload: []*string{
jsii.String("additionalStagingLabelsToDownload"),
},
},
},
},
},
}
type CfnResourceDefinition_ResourceDownloadOwnerSettingProperty ¶
type CfnResourceDefinition_ResourceDownloadOwnerSettingProperty struct {
// The group owner of the machine learning resource.
//
// This is the group ID (GID) of an existing Linux OS group on the system. The group's permissions are added to the Lambda process.
GroupOwner *string `json:"groupOwner" yaml:"groupOwner"`
// The permissions that the group owner has to the machine learning resource.
//
// Valid values are `rw` (read-write) or `ro` (read-only).
GroupPermission *string `json:"groupPermission" yaml:"groupPermission"`
}
The owner setting for a downloaded machine learning resource.
For more information, see [Access Machine Learning Resources from Lambda Functions](https://docs.aws.amazon.com/greengrass/latest/developerguide/access-ml-resources.html) in the *Developer Guide* .
In an AWS CloudFormation template, `ResourceDownloadOwnerSetting` is the property type of the `OwnerSetting` property for the [`S3MachineLearningModelResourceData`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-s3machinelearningmodelresourcedata.html) and [`SageMakerMachineLearningModelResourceData`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-sagemakermachinelearningmodelresourcedata.html) property types.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import greengrass "github.com/aws/aws-cdk-go/awscdk/aws_greengrass"
resourceDownloadOwnerSettingProperty := &resourceDownloadOwnerSettingProperty{
groupOwner: jsii.String("groupOwner"),
groupPermission: jsii.String("groupPermission"),
}
type CfnResourceDefinition_ResourceInstanceProperty ¶
type CfnResourceDefinition_ResourceInstanceProperty struct {
// A descriptive or arbitrary ID for the resource.
//
// This value must be unique within the resource definition version. Maximum length is 128 characters with pattern `[a-zA-Z0-9:_-]+` .
Id *string `json:"id" yaml:"id"`
// The descriptive resource name, which is displayed on the AWS IoT Greengrass console.
//
// Maximum length 128 characters with pattern [a-zA-Z0-9:_-]+. This must be unique within a Greengrass group.
Name *string `json:"name" yaml:"name"`
// A container for resource data.
//
// The container takes only one of the following supported resource data types: `LocalDeviceResourceData` , `LocalVolumeResourceData` , `SageMakerMachineLearningModelResourceData` , `S3MachineLearningModelResourceData` , or `SecretsManagerSecretResourceData` .
//
// > Only one resource type can be defined for a `ResourceDataContainer` instance.
ResourceDataContainer interface{} `json:"resourceDataContainer" yaml:"resourceDataContainer"`
}
A local resource, machine learning resource, or secret resource.
For more information, see [Access Local Resources with Lambda Functions](https://docs.aws.amazon.com/greengrass/latest/developerguide/access-local-resources.html) , [Perform Machine Learning Inference](https://docs.aws.amazon.com/greengrass/latest/developerguide/ml-inference.html) , and [Deploy Secrets to the AWS IoT Greengrass Core](https://docs.aws.amazon.com/greengrass/latest/developerguide/secrets.html) in the *Developer Guide* .
In an AWS CloudFormation template, the `Resources` property of the [`AWS::Greengrass::ResourceDefinition`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-resourcedefinition.html) resource contains a list of `ResourceInstance` property types.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import greengrass "github.com/aws/aws-cdk-go/awscdk/aws_greengrass"
resourceInstanceProperty := &resourceInstanceProperty{
id: jsii.String("id"),
name: jsii.String("name"),
resourceDataContainer: &resourceDataContainerProperty{
localDeviceResourceData: &localDeviceResourceDataProperty{
sourcePath: jsii.String("sourcePath"),
// the properties below are optional
groupOwnerSetting: &groupOwnerSettingProperty{
autoAddGroupOwner: jsii.Boolean(false),
// the properties below are optional
groupOwner: jsii.String("groupOwner"),
},
},
localVolumeResourceData: &localVolumeResourceDataProperty{
destinationPath: jsii.String("destinationPath"),
sourcePath: jsii.String("sourcePath"),
// the properties below are optional
groupOwnerSetting: &groupOwnerSettingProperty{
autoAddGroupOwner: jsii.Boolean(false),
// the properties below are optional
groupOwner: jsii.String("groupOwner"),
},
},
s3MachineLearningModelResourceData: &s3MachineLearningModelResourceDataProperty{
destinationPath: jsii.String("destinationPath"),
s3Uri: jsii.String("s3Uri"),
// the properties below are optional
ownerSetting: &resourceDownloadOwnerSettingProperty{
groupOwner: jsii.String("groupOwner"),
groupPermission: jsii.String("groupPermission"),
},
},
sageMakerMachineLearningModelResourceData: &sageMakerMachineLearningModelResourceDataProperty{
destinationPath: jsii.String("destinationPath"),
sageMakerJobArn: jsii.String("sageMakerJobArn"),
// the properties below are optional
ownerSetting: &resourceDownloadOwnerSettingProperty{
groupOwner: jsii.String("groupOwner"),
groupPermission: jsii.String("groupPermission"),
},
},
secretsManagerSecretResourceData: &secretsManagerSecretResourceDataProperty{
arn: jsii.String("arn"),
// the properties below are optional
additionalStagingLabelsToDownload: []*string{
jsii.String("additionalStagingLabelsToDownload"),
},
},
},
}
type CfnResourceDefinition_S3MachineLearningModelResourceDataProperty ¶
type CfnResourceDefinition_S3MachineLearningModelResourceDataProperty struct {
// The absolute local path of the resource inside the Lambda environment.
DestinationPath *string `json:"destinationPath" yaml:"destinationPath"`
// The URI of the source model in an Amazon S3 bucket.
//
// The model package must be in `tar.gz` or `.zip` format.
S3Uri *string `json:"s3Uri" yaml:"s3Uri"`
// The owner setting for the downloaded machine learning resource.
//
// For more information, see [Access Machine Learning Resources from Lambda Functions](https://docs.aws.amazon.com/greengrass/latest/developerguide/access-ml-resources.html) in the *Developer Guide* .
OwnerSetting interface{} `json:"ownerSetting" yaml:"ownerSetting"`
}
Settings for an Amazon S3 machine learning resource.
For more information, see [Perform Machine Learning Inference](https://docs.aws.amazon.com/greengrass/latest/developerguide/ml-inference.html) in the *Developer Guide* .
In an AWS CloudFormation template, `S3MachineLearningModelResourceData` can be used in the [`ResourceDataContainer`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-resourcedatacontainer.html) property type.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import greengrass "github.com/aws/aws-cdk-go/awscdk/aws_greengrass"
s3MachineLearningModelResourceDataProperty := &s3MachineLearningModelResourceDataProperty{
destinationPath: jsii.String("destinationPath"),
s3Uri: jsii.String("s3Uri"),
// the properties below are optional
ownerSetting: &resourceDownloadOwnerSettingProperty{
groupOwner: jsii.String("groupOwner"),
groupPermission: jsii.String("groupPermission"),
},
}
type CfnResourceDefinition_SageMakerMachineLearningModelResourceDataProperty ¶
type CfnResourceDefinition_SageMakerMachineLearningModelResourceDataProperty struct {
// The absolute local path of the resource inside the Lambda environment.
DestinationPath *string `json:"destinationPath" yaml:"destinationPath"`
// The Amazon Resource Name (ARN) of the Amazon SageMaker training job that represents the source model.
SageMakerJobArn *string `json:"sageMakerJobArn" yaml:"sageMakerJobArn"`
// The owner setting for the downloaded machine learning resource.
//
// For more information, see [Access Machine Learning Resources from Lambda Functions](https://docs.aws.amazon.com/greengrass/latest/developerguide/access-ml-resources.html) in the *Developer Guide* .
OwnerSetting interface{} `json:"ownerSetting" yaml:"ownerSetting"`
}
Settings for an Secrets Manager machine learning resource.
For more information, see [Perform Machine Learning Inference](https://docs.aws.amazon.com/greengrass/latest/developerguide/ml-inference.html) in the *Developer Guide* .
In an AWS CloudFormation template, `SageMakerMachineLearningModelResourceData` can be used in the [`ResourceDataContainer`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-resourcedatacontainer.html) property type.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import greengrass "github.com/aws/aws-cdk-go/awscdk/aws_greengrass"
sageMakerMachineLearningModelResourceDataProperty := &sageMakerMachineLearningModelResourceDataProperty{
destinationPath: jsii.String("destinationPath"),
sageMakerJobArn: jsii.String("sageMakerJobArn"),
// the properties below are optional
ownerSetting: &resourceDownloadOwnerSettingProperty{
groupOwner: jsii.String("groupOwner"),
groupPermission: jsii.String("groupPermission"),
},
}
type CfnResourceDefinition_SecretsManagerSecretResourceDataProperty ¶
type CfnResourceDefinition_SecretsManagerSecretResourceDataProperty struct {
// The Amazon Resource Name (ARN) of the Secrets Manager secret to make available on the core.
//
// The value of the secret's latest version (represented by the `AWSCURRENT` staging label) is included by default.
Arn *string `json:"arn" yaml:"arn"`
// The staging labels whose values you want to make available on the core, in addition to `AWSCURRENT` .
AdditionalStagingLabelsToDownload *[]*string `json:"additionalStagingLabelsToDownload" yaml:"additionalStagingLabelsToDownload"`
}
Settings for a secret resource, which references a secret from AWS Secrets Manager .
AWS IoT Greengrass stores a local, encrypted copy of the secret on the Greengrass core, where it can be securely accessed by connectors and Lambda functions. For more information, see [Deploy Secrets to the AWS IoT Greengrass Core](https://docs.aws.amazon.com/greengrass/latest/developerguide/secrets.html) in the *Developer Guide* .
In an AWS CloudFormation template, `SecretsManagerSecretResourceData` can be used in the [`ResourceDataContainer`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-resourcedatacontainer.html) property type.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import greengrass "github.com/aws/aws-cdk-go/awscdk/aws_greengrass"
secretsManagerSecretResourceDataProperty := &secretsManagerSecretResourceDataProperty{
arn: jsii.String("arn"),
// the properties below are optional
additionalStagingLabelsToDownload: []*string{
jsii.String("additionalStagingLabelsToDownload"),
},
}
type CfnSubscriptionDefinition ¶
type CfnSubscriptionDefinition interface {
awscdk.CfnResource
awscdk.IInspectable
// The Amazon Resource Name (ARN) of the `SubscriptionDefinition` , such as `arn:aws:greengrass:us-east-1: :/greengrass/definition/subscriptions/1234a5b6-78cd-901e-2fgh-3i45j6k178l9` .
AttrArn() *string
// The ID of the `SubscriptionDefinition` , such as `1234a5b6-78cd-901e-2fgh-3i45j6k178l9` .
AttrId() *string
// The ARN of the last `SubscriptionDefinitionVersion` that was added to the `SubscriptionDefinition` , such as `arn:aws:greengrass:us-east-1: :/greengrass/definition/subscriptions/1234a5b6-78cd-901e-2fgh-3i45j6k178l9/versions/9876ac30-4bdb-4f9d-95af-b5fdb66be1a2` .
AttrLatestVersionArn() *string
// The name of the `SubscriptionDefinition` , such as `MySubscriptionDefinition` .
AttrName() *string
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
// Returns: 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.
CreationStack() *[]*string
// The subscription definition version to include when the subscription definition is created.
//
// A subscription definition version contains a list of [`subscription`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-subscriptiondefinition-subscription.html) property types.
//
// > To associate a subscription definition version after the subscription definition is created, create an [`AWS::Greengrass::SubscriptionDefinitionVersion`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-subscriptiondefinitionversion.html) resource and specify the ID of this subscription definition.
InitialVersion() interface{}
SetInitialVersion(val interface{})
// 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)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
LogicalId() *string
// The name of the subscription definition.
Name() *string
SetName(val *string)
// The tree node.
Node() constructs.Node
// 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 })`.
Ref() *string
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// Application-specific metadata to attach to the subscription definition.
//
// You can use tags in IAM policies to control access to AWS IoT Greengrass resources. You can also use tags to categorize your resources. For more information, see [Tagging Your AWS IoT Greengrass Resources](https://docs.aws.amazon.com/greengrass/latest/developerguide/tagging.html) in the *Developer Guide* .
//
// This `Json` property type is processed as a map of key-value pairs. It uses the following format, which is different from most `Tags` implementations in AWS CloudFormation templates.
//
// “`json
// "Tags": { "KeyName0": "value", "KeyName1": "value", "KeyName2": "value"
// }
// “`.
Tags() awscdk.TagManager
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// 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.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// 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.
//
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` 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,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` 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.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
// 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`).
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
// 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.
GetAtt(attributeName *string) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// 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.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::Greengrass::SubscriptionDefinition`.
The `AWS::Greengrass::SubscriptionDefinition` resource represents a subscription definition for AWS IoT Greengrass . Subscription definitions are used to organize your subscription definition versions.
Subscription definitions can reference multiple subscription definition versions. All subscription definition versions must be associated with a subscription definition. Each subscription definition version can contain one or more subscriptions.
> When you create a subscription definition, you can optionally include an initial subscription definition version. To associate a subscription definition version later, create an [`AWS::Greengrass::SubscriptionDefinitionVersion`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-subscriptiondefinitionversion.html) resource and specify the ID of this subscription definition. > > After you create the subscription definition version that contains the subscriptions you want to deploy, you must add it to your group version. For more information, see [`AWS::Greengrass::Group`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html) .
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import greengrass "github.com/aws/aws-cdk-go/awscdk/aws_greengrass"
var tags interface{}
cfnSubscriptionDefinition := greengrass.NewCfnSubscriptionDefinition(this, jsii.String("MyCfnSubscriptionDefinition"), &cfnSubscriptionDefinitionProps{
name: jsii.String("name"),
// the properties below are optional
initialVersion: &subscriptionDefinitionVersionProperty{
subscriptions: []interface{}{
&subscriptionProperty{
id: jsii.String("id"),
source: jsii.String("source"),
subject: jsii.String("subject"),
target: jsii.String("target"),
},
},
},
tags: tags,
})
func NewCfnSubscriptionDefinition ¶
func NewCfnSubscriptionDefinition(scope constructs.Construct, id *string, props *CfnSubscriptionDefinitionProps) CfnSubscriptionDefinition
Create a new `AWS::Greengrass::SubscriptionDefinition`.
type CfnSubscriptionDefinitionProps ¶
type CfnSubscriptionDefinitionProps struct {
// The name of the subscription definition.
Name *string `json:"name" yaml:"name"`
// The subscription definition version to include when the subscription definition is created.
//
// A subscription definition version contains a list of [`subscription`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-subscriptiondefinition-subscription.html) property types.
//
// > To associate a subscription definition version after the subscription definition is created, create an [`AWS::Greengrass::SubscriptionDefinitionVersion`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-subscriptiondefinitionversion.html) resource and specify the ID of this subscription definition.
InitialVersion interface{} `json:"initialVersion" yaml:"initialVersion"`
// Application-specific metadata to attach to the subscription definition.
//
// You can use tags in IAM policies to control access to AWS IoT Greengrass resources. You can also use tags to categorize your resources. For more information, see [Tagging Your AWS IoT Greengrass Resources](https://docs.aws.amazon.com/greengrass/latest/developerguide/tagging.html) in the *Developer Guide* .
//
// This `Json` property type is processed as a map of key-value pairs. It uses the following format, which is different from most `Tags` implementations in AWS CloudFormation templates.
//
// “`json
// "Tags": { "KeyName0": "value", "KeyName1": "value", "KeyName2": "value"
// }
// “`.
Tags interface{} `json:"tags" yaml:"tags"`
}
Properties for defining a `CfnSubscriptionDefinition`.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import greengrass "github.com/aws/aws-cdk-go/awscdk/aws_greengrass"
var tags interface{}
cfnSubscriptionDefinitionProps := &cfnSubscriptionDefinitionProps{
name: jsii.String("name"),
// the properties below are optional
initialVersion: &subscriptionDefinitionVersionProperty{
subscriptions: []interface{}{
&subscriptionProperty{
id: jsii.String("id"),
source: jsii.String("source"),
subject: jsii.String("subject"),
target: jsii.String("target"),
},
},
},
tags: tags,
}
type CfnSubscriptionDefinitionVersion ¶
type CfnSubscriptionDefinitionVersion interface {
awscdk.CfnResource
awscdk.IInspectable
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
// Returns: 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.
CreationStack() *[]*string
// 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)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
LogicalId() *string
// The tree node.
Node() constructs.Node
// 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 })`.
Ref() *string
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// The ID of the subscription definition associated with this version.
//
// This value is a GUID.
SubscriptionDefinitionId() *string
SetSubscriptionDefinitionId(val *string)
// The subscriptions in this version.
Subscriptions() interface{}
SetSubscriptions(val interface{})
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// 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.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// 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.
//
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` 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,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` 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.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
// 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`).
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
// 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.
GetAtt(attributeName *string) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// 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.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::Greengrass::SubscriptionDefinitionVersion`.
The `AWS::Greengrass::SubscriptionDefinitionVersion` resource represents a subscription definition version for AWS IoT Greengrass . A subscription definition version contains a list of subscriptions.
> To create a subscription definition version, you must specify the ID of the subscription definition that you want to associate with the version. For information about creating a subscription definition, see [`AWS::Greengrass::SubscriptionDefinition`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-subscriptiondefinition.html) . > > After you create a subscription definition version that contains the subscriptions you want to deploy, you must add it to your group version. For more information, see [`AWS::Greengrass::Group`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html) .
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import greengrass "github.com/aws/aws-cdk-go/awscdk/aws_greengrass"
cfnSubscriptionDefinitionVersion := greengrass.NewCfnSubscriptionDefinitionVersion(this, jsii.String("MyCfnSubscriptionDefinitionVersion"), &cfnSubscriptionDefinitionVersionProps{
subscriptionDefinitionId: jsii.String("subscriptionDefinitionId"),
subscriptions: []interface{}{
&subscriptionProperty{
id: jsii.String("id"),
source: jsii.String("source"),
subject: jsii.String("subject"),
target: jsii.String("target"),
},
},
})
func NewCfnSubscriptionDefinitionVersion ¶
func NewCfnSubscriptionDefinitionVersion(scope constructs.Construct, id *string, props *CfnSubscriptionDefinitionVersionProps) CfnSubscriptionDefinitionVersion
Create a new `AWS::Greengrass::SubscriptionDefinitionVersion`.
type CfnSubscriptionDefinitionVersionProps ¶
type CfnSubscriptionDefinitionVersionProps struct {
// The ID of the subscription definition associated with this version.
//
// This value is a GUID.
SubscriptionDefinitionId *string `json:"subscriptionDefinitionId" yaml:"subscriptionDefinitionId"`
// The subscriptions in this version.
Subscriptions interface{} `json:"subscriptions" yaml:"subscriptions"`
}
Properties for defining a `CfnSubscriptionDefinitionVersion`.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import greengrass "github.com/aws/aws-cdk-go/awscdk/aws_greengrass"
cfnSubscriptionDefinitionVersionProps := &cfnSubscriptionDefinitionVersionProps{
subscriptionDefinitionId: jsii.String("subscriptionDefinitionId"),
subscriptions: []interface{}{
&subscriptionProperty{
id: jsii.String("id"),
source: jsii.String("source"),
subject: jsii.String("subject"),
target: jsii.String("target"),
},
},
}
type CfnSubscriptionDefinitionVersion_SubscriptionProperty ¶
type CfnSubscriptionDefinitionVersion_SubscriptionProperty struct {
// A descriptive or arbitrary ID for the subscription.
//
// This value must be unique within the subscription definition version. Maximum length is 128 characters with pattern `[a-zA-Z0-9:_-]+` .
Id *string `json:"id" yaml:"id"`
// The originator of the message.
//
// The value can be a thing ARN, the ARN of a Lambda function alias (recommended) or version, a connector ARN, `cloud` (which represents the AWS IoT cloud), or `GGShadowService` .
Source *string `json:"source" yaml:"source"`
// The MQTT topic used to route the message.
Subject *string `json:"subject" yaml:"subject"`
// The destination of the message.
//
// The value can be a thing ARN, the ARN of a Lambda function alias (recommended) or version, a connector ARN, `cloud` (which represents the AWS IoT cloud), or `GGShadowService` .
Target *string `json:"target" yaml:"target"`
}
Subscriptions define how MQTT messages can be exchanged between devices, functions, and connectors in the group, and with AWS IoT or the local shadow service.
A subscription defines a message source, message target, and a topic (or subject) that's used to route messages from the source to the target. A subscription defines the message flow in one direction, from the source to the target. For two-way communication, you must set up two subscriptions, one for each direction.
In an AWS CloudFormation template, the `Subscriptions` property of the [`AWS::Greengrass::SubscriptionDefinitionVersion`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-subscriptiondefinitionversion.html) resource contains a list of `Subscription` property types.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import greengrass "github.com/aws/aws-cdk-go/awscdk/aws_greengrass"
subscriptionProperty := &subscriptionProperty{
id: jsii.String("id"),
source: jsii.String("source"),
subject: jsii.String("subject"),
target: jsii.String("target"),
}
type CfnSubscriptionDefinition_SubscriptionDefinitionVersionProperty ¶
type CfnSubscriptionDefinition_SubscriptionDefinitionVersionProperty struct {
// The subscriptions in this version.
Subscriptions interface{} `json:"subscriptions" yaml:"subscriptions"`
}
A subscription definition version contains a list of [subscriptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-subscriptiondefinition-subscription.html) .
> After you create a subscription definition version that contains the subscriptions you want to deploy, you must add it to your group version. For more information, see [`AWS::Greengrass::Group`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html) .
In an AWS CloudFormation template, `SubscriptionDefinitionVersion` is the property type of the `InitialVersion` property in the [`AWS::Greengrass::SubscriptionDefinition`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-subscriptiondefinition.html) resource.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import greengrass "github.com/aws/aws-cdk-go/awscdk/aws_greengrass"
subscriptionDefinitionVersionProperty := &subscriptionDefinitionVersionProperty{
subscriptions: []interface{}{
&subscriptionProperty{
id: jsii.String("id"),
source: jsii.String("source"),
subject: jsii.String("subject"),
target: jsii.String("target"),
},
},
}
type CfnSubscriptionDefinition_SubscriptionProperty ¶
type CfnSubscriptionDefinition_SubscriptionProperty struct {
// A descriptive or arbitrary ID for the subscription.
//
// This value must be unique within the subscription definition version. Maximum length is 128 characters with pattern `[a-zA-Z0-9:_-]+` .
Id *string `json:"id" yaml:"id"`
// The originator of the message.
//
// The value can be a thing ARN, the ARN of a Lambda function alias (recommended) or version, a connector ARN, `cloud` (which represents the AWS IoT cloud), or `GGShadowService` .
Source *string `json:"source" yaml:"source"`
// The MQTT topic used to route the message.
Subject *string `json:"subject" yaml:"subject"`
// The destination of the message.
//
// The value can be a thing ARN, the ARN of a Lambda function alias (recommended) or version, a connector ARN, `cloud` (which represents the AWS IoT cloud), or `GGShadowService` .
Target *string `json:"target" yaml:"target"`
}
Subscriptions define how MQTT messages can be exchanged between devices, functions, and connectors in the group, and with AWS IoT or the local shadow service.
A subscription defines a message source, message target, and a topic (or subject) that's used to route messages from the source to the target. A subscription defines the message flow in one direction, from the source to the target. For two-way communication, you must set up two subscriptions, one for each direction.
In an AWS CloudFormation template, the `Subscriptions` property of the [`SubscriptionDefinitionVersion`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-subscriptiondefinition-subscriptiondefinitionversion.html) property type contains a list of `Subscription` property types.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import greengrass "github.com/aws/aws-cdk-go/awscdk/aws_greengrass"
subscriptionProperty := &subscriptionProperty{
id: jsii.String("id"),
source: jsii.String("source"),
subject: jsii.String("subject"),
target: jsii.String("target"),
}
Source Files
Directories
Click to show internal directories.
Click to hide internal directories.