{ "author": { "name": "Amazon Web Services", "organization": true, "roles": [ "author" ], "url": "https://aws.amazon.com" }, "dependencies": { "@aws-cdk/core": "1.204.0", "constructs": "^3.3.69" }, "dependencyClosure": { "@aws-cdk/cloud-assembly-schema": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.CloudAssembly.Schema", "packageId": "Amazon.CDK.CloudAssembly.Schema" }, "java": { "maven": { "artifactId": "cdk-cloud-assembly-schema", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.cloudassembly.schema" }, "js": { "npm": "@aws-cdk/cloud-assembly-schema" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.cloud-assembly-schema", "module": "aws_cdk.cloud_assembly_schema" } } }, "@aws-cdk/core": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK", "packageId": "Amazon.CDK" }, "java": { "maven": { "artifactId": "core", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.core" }, "js": { "npm": "@aws-cdk/core" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.core", "module": "aws_cdk.core" } } }, "@aws-cdk/cx-api": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.CXAPI", "packageId": "Amazon.CDK.CXAPI" }, "java": { "maven": { "artifactId": "cdk-cx-api", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.cxapi" }, "js": { "npm": "@aws-cdk/cx-api" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.cx-api", "module": "aws_cdk.cx_api" } } }, "@aws-cdk/region-info": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.RegionInfo", "packageId": "Amazon.CDK.RegionInfo" }, "java": { "maven": { "artifactId": "cdk-region-info", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.regioninfo" }, "js": { "npm": "@aws-cdk/region-info" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.region-info", "module": "aws_cdk.region_info" } } }, "constructs": { "targets": { "dotnet": { "namespace": "Constructs", "packageId": "Constructs" }, "go": { "moduleName": "github.com/aws/constructs-go" }, "java": { "maven": { "artifactId": "constructs", "groupId": "software.constructs" }, "package": "software.constructs" }, "js": { "npm": "constructs" }, "python": { "distName": "constructs", "module": "constructs" } } } }, "description": "The CDK Construct Library for AWS::Greengrass", "docs": { "deprecated": "AWS CDK v1 has reached End-of-Support on 2023-06-01.\nThis package is no longer being updated, and users should migrate to AWS CDK v2.\n\nFor more information on how to migrate, see https://docs.aws.amazon.com/cdk/v2/guide/migrating-v2.html", "stability": "experimental" }, "homepage": "https://github.com/aws/aws-cdk", "jsiiVersion": "1.84.0 (build 5404dcf)", "keywords": [ "aws", "cdk", "constructs", "AWS::Greengrass", "aws-greengrass" ], "license": "Apache-2.0", "metadata": { "jsii": { "compiledWithDeprecationWarnings": true, "pacmak": { "hasDefaultInterfaces": true }, "rosetta": { "strict": true } } }, "name": "@aws-cdk/aws-greengrass", "readme": { "markdown": "# AWS IoT Greengrass Construct Library\n\n\n---\n\n![End-of-Support](https://img.shields.io/badge/End--of--Support-critical.svg?style=for-the-badge)\n\n> AWS CDK v1 has reached End-of-Support on 2023-06-01.\n> This package is no longer being updated, and users should migrate to AWS CDK v2.\n>\n> For more information on how to migrate, see the [_Migrating to AWS CDK v2_ guide][doc].\n>\n> [doc]: https://docs.aws.amazon.com/cdk/v2/guide/migrating-v2.html\n\n---\n\n\n\nThis module is part of the [AWS Cloud Development Kit](https://github.com/aws/aws-cdk) project.\n\n```ts nofixture\nimport * as greengrass from '@aws-cdk/aws-greengrass';\n```\n\n\n\nThere are no official hand-written ([L2](https://docs.aws.amazon.com/cdk/latest/guide/constructs.html#constructs_lib)) constructs for this service yet. Here are some suggestions on how to proceed:\n\n- Search [Construct Hub for Greengrass construct libraries](https://constructs.dev/search?q=greengrass)\n- Use the automatically generated [L1](https://docs.aws.amazon.com/cdk/latest/guide/constructs.html#constructs_l1_using) constructs, in the same way you would use [the CloudFormation AWS::Greengrass resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/AWS_Greengrass.html) directly.\n\n\n\n\nThere are no hand-written ([L2](https://docs.aws.amazon.com/cdk/latest/guide/constructs.html#constructs_lib)) constructs for this service yet.\nHowever, you can still use the automatically generated [L1](https://docs.aws.amazon.com/cdk/latest/guide/constructs.html#constructs_l1_using) constructs, and use this service exactly as you would using CloudFormation directly.\n\nFor more information on the resources and properties available for this service, see the [CloudFormation documentation for AWS::Greengrass](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/AWS_Greengrass.html).\n\n(Read the [CDK Contributing Guide](https://github.com/aws/aws-cdk/blob/master/CONTRIBUTING.md) and submit an RFC if you are interested in contributing to this construct library.)\n\n\n" }, "repository": { "directory": "packages/@aws-cdk/aws-greengrass", "type": "git", "url": "https://github.com/aws/aws-cdk.git" }, "schema": "jsii/0.10.0", "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.Greengrass", "packageId": "Amazon.CDK.AWS.Greengrass" }, "java": { "maven": { "artifactId": "greengrass", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.greengrass" }, "js": { "npm": "@aws-cdk/aws-greengrass" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-greengrass", "module": "aws_cdk.aws_greengrass" } }, "types": { "@aws-cdk/aws-greengrass.CfnConnectorDefinition": { "assembly": "@aws-cdk/aws-greengrass", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::Greengrass::ConnectorDefinition", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-connectordefinition.html", "exampleMetadata": "fixture=_generated" }, "remarks": "The `AWS::Greengrass::ConnectorDefinition` resource represents a connector definition for AWS IoT Greengrass . Connector definitions are used to organize your connector definition versions.\n\nConnector 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.\n\n> 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.\n>\n> 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) .", "stability": "external", "summary": "A CloudFormation `AWS::Greengrass::ConnectorDefinition`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as greengrass from '@aws-cdk/aws-greengrass';\n\ndeclare const parameters: any;\ndeclare const tags: any;\nconst cfnConnectorDefinition = new greengrass.CfnConnectorDefinition(this, 'MyCfnConnectorDefinition', {\n name: 'name',\n\n // the properties below are optional\n initialVersion: {\n connectors: [{\n connectorArn: 'connectorArn',\n id: 'id',\n\n // the properties below are optional\n parameters: parameters,\n }],\n },\n tags: tags,\n});" }, "fqn": "@aws-cdk/aws-greengrass.CfnConnectorDefinition", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::Greengrass::ConnectorDefinition`." }, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 206 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "@aws-cdk/aws-greengrass.CfnConnectorDefinitionProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 120 }, "methods": [ { "docs": { "stability": "external", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 225 }, "name": "inspect", "overrides": "@aws-cdk/core.IInspectable", "parameters": [ { "docs": { "summary": "- tree inspector to collect and process attributes." }, "name": "inspector", "type": { "fqn": "@aws-cdk/core.TreeInspector" } } ] }, { "docs": { "stability": "external" }, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 238 }, "name": "renderProperties", "overrides": "@aws-cdk/core.CfnResource", "parameters": [ { "name": "props", "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } ], "protected": true, "returns": { "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } } ], "name": "CfnConnectorDefinition", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 124 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "Arn" }, "stability": "external", "summary": "The Amazon Resource Name (ARN) of the `ConnectorDefinition` , such as `arn:aws:greengrass:us-east-1: :/greengrass/definition/connectors/1234a5b6-78cd-901e-2fgh-3i45j6k178l9` ." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 149 }, "name": "attrArn", "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "Id" }, "stability": "external", "summary": "The ID of the `ConnectorDefinition` , such as `1234a5b6-78cd-901e-2fgh-3i45j6k178l9` ." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 155 }, "name": "attrId", "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "LatestVersionArn" }, "stability": "external", "summary": "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` ." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 161 }, "name": "attrLatestVersionArn", "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "Name" }, "stability": "external", "summary": "The name of the `ConnectorDefinition` , such as `MyConnectorDefinition` ." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 167 }, "name": "attrName", "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 230 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-connectordefinition.html#cfn-greengrass-connectordefinition-tags" }, "remarks": "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* .\n\nThis `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.\n\n```json\n\"Tags\": { \"KeyName0\": \"value\", \"KeyName1\": \"value\", \"KeyName2\": \"value\"\n}\n```", "stability": "external", "summary": "Application-specific metadata to attach to the connector definition." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 197 }, "name": "tags", "type": { "fqn": "@aws-cdk/core.TagManager" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-connectordefinition.html#cfn-greengrass-connectordefinition-name" }, "stability": "external", "summary": "The name of the connector definition." }, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 174 }, "name": "name", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-connectordefinition.html#cfn-greengrass-connectordefinition-initialversion" }, "remarks": "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.\n\n> 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.", "stability": "external", "summary": "The connector definition version to include when the connector definition is created." }, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 183 }, "name": "initialVersion", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/aws-greengrass.CfnConnectorDefinition.ConnectorDefinitionVersionProperty" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } } ], "symbolId": "lib/greengrass.generated:CfnConnectorDefinition" }, "@aws-cdk/aws-greengrass.CfnConnectorDefinition.ConnectorDefinitionVersionProperty": { "assembly": "@aws-cdk/aws-greengrass", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-connectordefinition-connectordefinitionversion.html", "exampleMetadata": "fixture=_generated" }, "remarks": "> 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) .\n\nIn 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.", "stability": "external", "summary": "A connector definition version contains a list of connectors.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as greengrass from '@aws-cdk/aws-greengrass';\n\ndeclare const parameters: any;\nconst connectorDefinitionVersionProperty: greengrass.CfnConnectorDefinition.ConnectorDefinitionVersionProperty = {\n connectors: [{\n connectorArn: 'connectorArn',\n id: 'id',\n\n // the properties below are optional\n parameters: parameters,\n }],\n};" }, "fqn": "@aws-cdk/aws-greengrass.CfnConnectorDefinition.ConnectorDefinitionVersionProperty", "kind": "interface", "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 349 }, "name": "ConnectorDefinitionVersionProperty", "namespace": "CfnConnectorDefinition", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-connectordefinition-connectordefinitionversion.html#cfn-greengrass-connectordefinition-connectordefinitionversion-connectors" }, "remarks": "Only one instance of a given connector can be added to a connector definition version at a time.", "stability": "external", "summary": "The connectors in this version." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 355 }, "name": "connectors", "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-greengrass.CfnConnectorDefinition.ConnectorProperty" } ] } }, "kind": "array" } } ] } } } ], "symbolId": "lib/greengrass.generated:CfnConnectorDefinition.ConnectorDefinitionVersionProperty" }, "@aws-cdk/aws-greengrass.CfnConnectorDefinition.ConnectorProperty": { "assembly": "@aws-cdk/aws-greengrass", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-connectordefinition-connector.html", "exampleMetadata": "fixture=_generated" }, "remarks": "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* .\n\nIn 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.", "stability": "external", "summary": "Connectors are modules that provide built-in integration with local infrastructure, device protocols, AWS , and other cloud services.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as greengrass from '@aws-cdk/aws-greengrass';\n\ndeclare const parameters: any;\nconst connectorProperty: greengrass.CfnConnectorDefinition.ConnectorProperty = {\n connectorArn: 'connectorArn',\n id: 'id',\n\n // the properties below are optional\n parameters: parameters,\n};" }, "fqn": "@aws-cdk/aws-greengrass.CfnConnectorDefinition.ConnectorProperty", "kind": "interface", "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 254 }, "name": "ConnectorProperty", "namespace": "CfnConnectorDefinition", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-connectordefinition-connector.html#cfn-greengrass-connectordefinition-connector-connectorarn" }, "remarks": "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) .", "stability": "external", "summary": "The Amazon Resource Name (ARN) of the connector." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 262 }, "name": "connectorArn", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-connectordefinition-connector.html#cfn-greengrass-connectordefinition-connector-id" }, "remarks": "This value must be unique within the connector definition version. Maximum length is 128 characters with pattern `[a-zA-Z0-9:_-]+` .", "stability": "external", "summary": "A descriptive or arbitrary ID for the connector." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 268 }, "name": "id", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-connectordefinition-connector.html#cfn-greengrass-connectordefinition-connector-parameters" }, "remarks": "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) .", "stability": "external", "summary": "The parameters or configuration used by the connector." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 276 }, "name": "parameters", "optional": true, "type": { "primitive": "any" } } ], "symbolId": "lib/greengrass.generated:CfnConnectorDefinition.ConnectorProperty" }, "@aws-cdk/aws-greengrass.CfnConnectorDefinitionProps": { "assembly": "@aws-cdk/aws-greengrass", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-connectordefinition.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Properties for defining a `CfnConnectorDefinition`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as greengrass from '@aws-cdk/aws-greengrass';\n\ndeclare const parameters: any;\ndeclare const tags: any;\nconst cfnConnectorDefinitionProps: greengrass.CfnConnectorDefinitionProps = {\n name: 'name',\n\n // the properties below are optional\n initialVersion: {\n connectors: [{\n connectorArn: 'connectorArn',\n id: 'id',\n\n // the properties below are optional\n parameters: parameters,\n }],\n },\n tags: tags,\n};" }, "fqn": "@aws-cdk/aws-greengrass.CfnConnectorDefinitionProps", "kind": "interface", "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 19 }, "name": "CfnConnectorDefinitionProps", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-connectordefinition.html#cfn-greengrass-connectordefinition-name" }, "stability": "external", "summary": "The name of the connector definition." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 26 }, "name": "name", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-connectordefinition.html#cfn-greengrass-connectordefinition-initialversion" }, "remarks": "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.\n\n> 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.", "stability": "external", "summary": "The connector definition version to include when the connector definition is created." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 35 }, "name": "initialVersion", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/aws-greengrass.CfnConnectorDefinition.ConnectorDefinitionVersionProperty" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-connectordefinition.html#cfn-greengrass-connectordefinition-tags" }, "remarks": "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* .\n\nThis `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.\n\n```json\n\"Tags\": { \"KeyName0\": \"value\", \"KeyName1\": \"value\", \"KeyName2\": \"value\"\n}\n```", "stability": "external", "summary": "Application-specific metadata to attach to the connector definition." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 49 }, "name": "tags", "optional": true, "type": { "primitive": "any" } } ], "symbolId": "lib/greengrass.generated:CfnConnectorDefinitionProps" }, "@aws-cdk/aws-greengrass.CfnConnectorDefinitionVersion": { "assembly": "@aws-cdk/aws-greengrass", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::Greengrass::ConnectorDefinitionVersion", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-connectordefinitionversion.html", "exampleMetadata": "fixture=_generated" }, "remarks": "The `AWS::Greengrass::ConnectorDefinitionVersion` resource represents a connector definition version for AWS IoT Greengrass . A connector definition version contains a list of connectors.\n\n> 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) .\n>\n> 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) .", "stability": "external", "summary": "A CloudFormation `AWS::Greengrass::ConnectorDefinitionVersion`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as greengrass from '@aws-cdk/aws-greengrass';\n\ndeclare const parameters: any;\nconst cfnConnectorDefinitionVersion = new greengrass.CfnConnectorDefinitionVersion(this, 'MyCfnConnectorDefinitionVersion', {\n connectorDefinitionId: 'connectorDefinitionId',\n connectors: [{\n connectorArn: 'connectorArn',\n id: 'id',\n\n // the properties below are optional\n parameters: parameters,\n }],\n});" }, "fqn": "@aws-cdk/aws-greengrass.CfnConnectorDefinitionVersion", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::Greengrass::ConnectorDefinitionVersion`." }, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 543 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "@aws-cdk/aws-greengrass.CfnConnectorDefinitionVersionProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 497 }, "methods": [ { "docs": { "stability": "external", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 558 }, "name": "inspect", "overrides": "@aws-cdk/core.IInspectable", "parameters": [ { "docs": { "summary": "- tree inspector to collect and process attributes." }, "name": "inspector", "type": { "fqn": "@aws-cdk/core.TreeInspector" } } ] }, { "docs": { "stability": "external" }, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 570 }, "name": "renderProperties", "overrides": "@aws-cdk/core.CfnResource", "parameters": [ { "name": "props", "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } ], "protected": true, "returns": { "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } } ], "name": "CfnConnectorDefinitionVersion", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 501 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 563 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-connectordefinitionversion.html#cfn-greengrass-connectordefinitionversion-connectordefinitionid" }, "remarks": "This value is a GUID.", "stability": "external", "summary": "The ID of the connector definition associated with this version." }, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 527 }, "name": "connectorDefinitionId", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-connectordefinitionversion.html#cfn-greengrass-connectordefinitionversion-connectors" }, "remarks": "Only one instance of a given connector can be added to the connector definition version at a time.", "stability": "external", "summary": "The connectors in this version." }, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 534 }, "name": "connectors", "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-greengrass.CfnConnectorDefinitionVersion.ConnectorProperty" } ] } }, "kind": "array" } } ] } } } ], "symbolId": "lib/greengrass.generated:CfnConnectorDefinitionVersion" }, "@aws-cdk/aws-greengrass.CfnConnectorDefinitionVersion.ConnectorProperty": { "assembly": "@aws-cdk/aws-greengrass", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-connectordefinitionversion-connector.html", "exampleMetadata": "fixture=_generated" }, "remarks": "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* .\n\nIn 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.", "stability": "external", "summary": "Connectors are modules that provide built-in integration with local infrastructure, device protocols, AWS , and other cloud services.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as greengrass from '@aws-cdk/aws-greengrass';\n\ndeclare const parameters: any;\nconst connectorProperty: greengrass.CfnConnectorDefinitionVersion.ConnectorProperty = {\n connectorArn: 'connectorArn',\n id: 'id',\n\n // the properties below are optional\n parameters: parameters,\n};" }, "fqn": "@aws-cdk/aws-greengrass.CfnConnectorDefinitionVersion.ConnectorProperty", "kind": "interface", "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 586 }, "name": "ConnectorProperty", "namespace": "CfnConnectorDefinitionVersion", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-connectordefinitionversion-connector.html#cfn-greengrass-connectordefinitionversion-connector-connectorarn" }, "remarks": "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) .", "stability": "external", "summary": "The Amazon Resource Name (ARN) of the connector." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 594 }, "name": "connectorArn", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-connectordefinitionversion-connector.html#cfn-greengrass-connectordefinitionversion-connector-id" }, "remarks": "This value must be unique within the connector definition version. Maximum length is 128 characters with pattern `[a-zA-Z0-9:_-]+` .", "stability": "external", "summary": "A descriptive or arbitrary ID for the connector." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 600 }, "name": "id", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-connectordefinitionversion-connector.html#cfn-greengrass-connectordefinitionversion-connector-parameters" }, "remarks": "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) .", "stability": "external", "summary": "The parameters or configuration that the connector uses." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 608 }, "name": "parameters", "optional": true, "type": { "primitive": "any" } } ], "symbolId": "lib/greengrass.generated:CfnConnectorDefinitionVersion.ConnectorProperty" }, "@aws-cdk/aws-greengrass.CfnConnectorDefinitionVersionProps": { "assembly": "@aws-cdk/aws-greengrass", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-connectordefinitionversion.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Properties for defining a `CfnConnectorDefinitionVersion`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as greengrass from '@aws-cdk/aws-greengrass';\n\ndeclare const parameters: any;\nconst cfnConnectorDefinitionVersionProps: greengrass.CfnConnectorDefinitionVersionProps = {\n connectorDefinitionId: 'connectorDefinitionId',\n connectors: [{\n connectorArn: 'connectorArn',\n id: 'id',\n\n // the properties below are optional\n parameters: parameters,\n }],\n};" }, "fqn": "@aws-cdk/aws-greengrass.CfnConnectorDefinitionVersionProps", "kind": "interface", "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 416 }, "name": "CfnConnectorDefinitionVersionProps", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-connectordefinitionversion.html#cfn-greengrass-connectordefinitionversion-connectordefinitionid" }, "remarks": "This value is a GUID.", "stability": "external", "summary": "The ID of the connector definition associated with this version." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 423 }, "name": "connectorDefinitionId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-connectordefinitionversion.html#cfn-greengrass-connectordefinitionversion-connectors" }, "remarks": "Only one instance of a given connector can be added to the connector definition version at a time.", "stability": "external", "summary": "The connectors in this version." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 430 }, "name": "connectors", "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-greengrass.CfnConnectorDefinitionVersion.ConnectorProperty" } ] } }, "kind": "array" } } ] } } } ], "symbolId": "lib/greengrass.generated:CfnConnectorDefinitionVersionProps" }, "@aws-cdk/aws-greengrass.CfnCoreDefinition": { "assembly": "@aws-cdk/aws-greengrass", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::Greengrass::CoreDefinition", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-coredefinition.html", "exampleMetadata": "fixture=_generated" }, "remarks": "The `AWS::Greengrass::CoreDefinition` resource represents a core definition for AWS IoT Greengrass . Core definitions are used to organize your core definition versions.\n\nCore 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.\n\n> 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.\n>\n> 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) .", "stability": "external", "summary": "A CloudFormation `AWS::Greengrass::CoreDefinition`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as greengrass from '@aws-cdk/aws-greengrass';\n\ndeclare const tags: any;\nconst cfnCoreDefinition = new greengrass.CfnCoreDefinition(this, 'MyCfnCoreDefinition', {\n name: 'name',\n\n // the properties below are optional\n initialVersion: {\n cores: [{\n certificateArn: 'certificateArn',\n id: 'id',\n thingArn: 'thingArn',\n\n // the properties below are optional\n syncShadow: false,\n }],\n },\n tags: tags,\n});" }, "fqn": "@aws-cdk/aws-greengrass.CfnCoreDefinition", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::Greengrass::CoreDefinition`." }, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 863 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "@aws-cdk/aws-greengrass.CfnCoreDefinitionProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 777 }, "methods": [ { "docs": { "stability": "external", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 882 }, "name": "inspect", "overrides": "@aws-cdk/core.IInspectable", "parameters": [ { "docs": { "summary": "- tree inspector to collect and process attributes." }, "name": "inspector", "type": { "fqn": "@aws-cdk/core.TreeInspector" } } ] }, { "docs": { "stability": "external" }, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 895 }, "name": "renderProperties", "overrides": "@aws-cdk/core.CfnResource", "parameters": [ { "name": "props", "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } ], "protected": true, "returns": { "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } } ], "name": "CfnCoreDefinition", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 781 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "Arn" }, "stability": "external", "summary": "The Amazon Resource Name (ARN) of the `CoreDefinition` , such as `arn:aws:greengrass:us-east-1: :/greengrass/definition/cores/1234a5b6-78cd-901e-2fgh-3i45j6k178l9` ." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 806 }, "name": "attrArn", "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "Id" }, "stability": "external", "summary": "The ID of the `CoreDefinition` , such as `1234a5b6-78cd-901e-2fgh-3i45j6k178l9` ." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 812 }, "name": "attrId", "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "LatestVersionArn" }, "stability": "external", "summary": "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` ." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 818 }, "name": "attrLatestVersionArn", "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "Name" }, "stability": "external", "summary": "The name of the `CoreDefinition` , such as `MyCoreDefinition` ." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 824 }, "name": "attrName", "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 887 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-coredefinition.html#cfn-greengrass-coredefinition-tags" }, "remarks": "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* .\n\nThis `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.\n\n```json\n\"Tags\": { \"KeyName0\": \"value\", \"KeyName1\": \"value\", \"KeyName2\": \"value\"\n}\n```", "stability": "external", "summary": "Application-specific metadata to attach to the core definition." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 854 }, "name": "tags", "type": { "fqn": "@aws-cdk/core.TagManager" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-coredefinition.html#cfn-greengrass-coredefinition-name" }, "stability": "external", "summary": "The name of the core definition." }, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 831 }, "name": "name", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-coredefinition.html#cfn-greengrass-coredefinition-initialversion" }, "remarks": "Currently, a core definition version can contain only one [`core`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-coredefinition-core.html) .\n\n> 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.", "stability": "external", "summary": "The core definition version to include when the core definition is created." }, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 840 }, "name": "initialVersion", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-greengrass.CfnCoreDefinition.CoreDefinitionVersionProperty" } ] } } } ], "symbolId": "lib/greengrass.generated:CfnCoreDefinition" }, "@aws-cdk/aws-greengrass.CfnCoreDefinition.CoreDefinitionVersionProperty": { "assembly": "@aws-cdk/aws-greengrass", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-coredefinition-coredefinitionversion.html", "exampleMetadata": "fixture=_generated" }, "remarks": "> 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) .\n\nIn 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.", "stability": "external", "summary": "A core definition version contains a Greengrass [core](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-coredefinition-core.html) .", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as greengrass from '@aws-cdk/aws-greengrass';\nconst coreDefinitionVersionProperty: greengrass.CfnCoreDefinition.CoreDefinitionVersionProperty = {\n cores: [{\n certificateArn: 'certificateArn',\n id: 'id',\n thingArn: 'thingArn',\n\n // the properties below are optional\n syncShadow: false,\n }],\n};" }, "fqn": "@aws-cdk/aws-greengrass.CfnCoreDefinition.CoreDefinitionVersionProperty", "kind": "interface", "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 1012 }, "name": "CoreDefinitionVersionProperty", "namespace": "CfnCoreDefinition", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-coredefinition-coredefinitionversion.html#cfn-greengrass-coredefinition-coredefinitionversion-cores" }, "remarks": "Currently, the `Cores` property for a core definition version can contain only one core.", "stability": "external", "summary": "The Greengrass core in this version." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 1018 }, "name": "cores", "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-greengrass.CfnCoreDefinition.CoreProperty" } ] } }, "kind": "array" } } ] } } } ], "symbolId": "lib/greengrass.generated:CfnCoreDefinition.CoreDefinitionVersionProperty" }, "@aws-cdk/aws-greengrass.CfnCoreDefinition.CoreProperty": { "assembly": "@aws-cdk/aws-greengrass", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-coredefinition-core.html", "exampleMetadata": "fixture=_generated" }, "remarks": "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* .\n\nIn 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.", "stability": "external", "summary": "A core is an AWS IoT device that runs the AWS IoT Greengrass core software and manages local processes for a Greengrass group.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as greengrass from '@aws-cdk/aws-greengrass';\nconst coreProperty: greengrass.CfnCoreDefinition.CoreProperty = {\n certificateArn: 'certificateArn',\n id: 'id',\n thingArn: 'thingArn',\n\n // the properties below are optional\n syncShadow: false,\n};" }, "fqn": "@aws-cdk/aws-greengrass.CfnCoreDefinition.CoreProperty", "kind": "interface", "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 911 }, "name": "CoreProperty", "namespace": "CfnCoreDefinition", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-coredefinition-core.html#cfn-greengrass-coredefinition-core-certificatearn" }, "remarks": "This X.509 certificate is used to authenticate the core with AWS IoT and AWS IoT Greengrass services.", "stability": "external", "summary": "The Amazon Resource Name (ARN) of the device certificate for the core." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 917 }, "name": "certificateArn", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-coredefinition-core.html#cfn-greengrass-coredefinition-core-id" }, "remarks": "This value must be unique within the core definition version. Maximum length is 128 characters with pattern `[a-zA-Z0-9:_-]+` .", "stability": "external", "summary": "A descriptive or arbitrary ID for the core." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 923 }, "name": "id", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-coredefinition-core.html#cfn-greengrass-coredefinition-core-thingarn" }, "stability": "external", "summary": "The ARN of the core, which is an AWS IoT device (thing)." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 935 }, "name": "thingArn", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-coredefinition-core.html#cfn-greengrass-coredefinition-core-syncshadow" }, "remarks": "The default is false.", "stability": "external", "summary": "Indicates whether the core's local shadow is synced with the cloud automatically." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 929 }, "name": "syncShadow", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } } ], "symbolId": "lib/greengrass.generated:CfnCoreDefinition.CoreProperty" }, "@aws-cdk/aws-greengrass.CfnCoreDefinitionProps": { "assembly": "@aws-cdk/aws-greengrass", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-coredefinition.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Properties for defining a `CfnCoreDefinition`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as greengrass from '@aws-cdk/aws-greengrass';\n\ndeclare const tags: any;\nconst cfnCoreDefinitionProps: greengrass.CfnCoreDefinitionProps = {\n name: 'name',\n\n // the properties below are optional\n initialVersion: {\n cores: [{\n certificateArn: 'certificateArn',\n id: 'id',\n thingArn: 'thingArn',\n\n // the properties below are optional\n syncShadow: false,\n }],\n },\n tags: tags,\n};" }, "fqn": "@aws-cdk/aws-greengrass.CfnCoreDefinitionProps", "kind": "interface", "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 676 }, "name": "CfnCoreDefinitionProps", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-coredefinition.html#cfn-greengrass-coredefinition-name" }, "stability": "external", "summary": "The name of the core definition." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 683 }, "name": "name", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-coredefinition.html#cfn-greengrass-coredefinition-initialversion" }, "remarks": "Currently, a core definition version can contain only one [`core`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-coredefinition-core.html) .\n\n> 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.", "stability": "external", "summary": "The core definition version to include when the core definition is created." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 692 }, "name": "initialVersion", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-greengrass.CfnCoreDefinition.CoreDefinitionVersionProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-coredefinition.html#cfn-greengrass-coredefinition-tags" }, "remarks": "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* .\n\nThis `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.\n\n```json\n\"Tags\": { \"KeyName0\": \"value\", \"KeyName1\": \"value\", \"KeyName2\": \"value\"\n}\n```", "stability": "external", "summary": "Application-specific metadata to attach to the core definition." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 706 }, "name": "tags", "optional": true, "type": { "primitive": "any" } } ], "symbolId": "lib/greengrass.generated:CfnCoreDefinitionProps" }, "@aws-cdk/aws-greengrass.CfnCoreDefinitionVersion": { "assembly": "@aws-cdk/aws-greengrass", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::Greengrass::CoreDefinitionVersion", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-coredefinitionversion.html", "exampleMetadata": "fixture=_generated" }, "remarks": "The `AWS::Greengrass::CoreDefinitionVersion` resource represents a core definition version for AWS IoT Greengrass . A core definition version contains a Greengrass core.\n\n> 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) .\n>\n> 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) .", "stability": "external", "summary": "A CloudFormation `AWS::Greengrass::CoreDefinitionVersion`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as greengrass from '@aws-cdk/aws-greengrass';\nconst cfnCoreDefinitionVersion = new greengrass.CfnCoreDefinitionVersion(this, 'MyCfnCoreDefinitionVersion', {\n coreDefinitionId: 'coreDefinitionId',\n cores: [{\n certificateArn: 'certificateArn',\n id: 'id',\n thingArn: 'thingArn',\n\n // the properties below are optional\n syncShadow: false,\n }],\n});" }, "fqn": "@aws-cdk/aws-greengrass.CfnCoreDefinitionVersion", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::Greengrass::CoreDefinitionVersion`." }, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 1206 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "@aws-cdk/aws-greengrass.CfnCoreDefinitionVersionProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 1160 }, "methods": [ { "docs": { "stability": "external", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 1221 }, "name": "inspect", "overrides": "@aws-cdk/core.IInspectable", "parameters": [ { "docs": { "summary": "- tree inspector to collect and process attributes." }, "name": "inspector", "type": { "fqn": "@aws-cdk/core.TreeInspector" } } ] }, { "docs": { "stability": "external" }, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 1233 }, "name": "renderProperties", "overrides": "@aws-cdk/core.CfnResource", "parameters": [ { "name": "props", "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } ], "protected": true, "returns": { "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } } ], "name": "CfnCoreDefinitionVersion", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 1164 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 1226 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-coredefinitionversion.html#cfn-greengrass-coredefinitionversion-coredefinitionid" }, "remarks": "This value is a GUID.", "stability": "external", "summary": "The ID of the core definition associated with this version." }, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 1190 }, "name": "coreDefinitionId", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-coredefinitionversion.html#cfn-greengrass-coredefinitionversion-cores" }, "remarks": "Currently, the `Cores` property for a core definition version can contain only one core.", "stability": "external", "summary": "The Greengrass core in this version." }, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 1197 }, "name": "cores", "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-greengrass.CfnCoreDefinitionVersion.CoreProperty" } ] } }, "kind": "array" } } ] } } } ], "symbolId": "lib/greengrass.generated:CfnCoreDefinitionVersion" }, "@aws-cdk/aws-greengrass.CfnCoreDefinitionVersion.CoreProperty": { "assembly": "@aws-cdk/aws-greengrass", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-coredefinitionversion-core.html", "exampleMetadata": "fixture=_generated" }, "remarks": "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* .\n\nIn 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.", "stability": "external", "summary": "A core is an AWS IoT device that runs the AWS IoT Greengrass core software and manages local processes for a Greengrass group.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as greengrass from '@aws-cdk/aws-greengrass';\nconst coreProperty: greengrass.CfnCoreDefinitionVersion.CoreProperty = {\n certificateArn: 'certificateArn',\n id: 'id',\n thingArn: 'thingArn',\n\n // the properties below are optional\n syncShadow: false,\n};" }, "fqn": "@aws-cdk/aws-greengrass.CfnCoreDefinitionVersion.CoreProperty", "kind": "interface", "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 1249 }, "name": "CoreProperty", "namespace": "CfnCoreDefinitionVersion", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-coredefinitionversion-core.html#cfn-greengrass-coredefinitionversion-core-certificatearn" }, "remarks": "This X.509 certificate is used to authenticate the core with AWS IoT and AWS IoT Greengrass services.", "stability": "external", "summary": "The ARN of the device certificate for the core." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 1255 }, "name": "certificateArn", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-coredefinitionversion-core.html#cfn-greengrass-coredefinitionversion-core-id" }, "remarks": "This value must be unique within the core definition version. Maximum length is 128 characters with pattern `[a-zA-Z0-9:_-]+` .", "stability": "external", "summary": "A descriptive or arbitrary ID for the core." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 1261 }, "name": "id", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-coredefinitionversion-core.html#cfn-greengrass-coredefinitionversion-core-thingarn" }, "stability": "external", "summary": "The Amazon Resource Name (ARN) of the core, which is an AWS IoT device (thing)." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 1273 }, "name": "thingArn", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-coredefinitionversion-core.html#cfn-greengrass-coredefinitionversion-core-syncshadow" }, "remarks": "The default is false.", "stability": "external", "summary": "Indicates whether the core's local shadow is synced with the cloud automatically." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 1267 }, "name": "syncShadow", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } } ], "symbolId": "lib/greengrass.generated:CfnCoreDefinitionVersion.CoreProperty" }, "@aws-cdk/aws-greengrass.CfnCoreDefinitionVersionProps": { "assembly": "@aws-cdk/aws-greengrass", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-coredefinitionversion.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Properties for defining a `CfnCoreDefinitionVersion`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as greengrass from '@aws-cdk/aws-greengrass';\nconst cfnCoreDefinitionVersionProps: greengrass.CfnCoreDefinitionVersionProps = {\n coreDefinitionId: 'coreDefinitionId',\n cores: [{\n certificateArn: 'certificateArn',\n id: 'id',\n thingArn: 'thingArn',\n\n // the properties below are optional\n syncShadow: false,\n }],\n};" }, "fqn": "@aws-cdk/aws-greengrass.CfnCoreDefinitionVersionProps", "kind": "interface", "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 1079 }, "name": "CfnCoreDefinitionVersionProps", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-coredefinitionversion.html#cfn-greengrass-coredefinitionversion-coredefinitionid" }, "remarks": "This value is a GUID.", "stability": "external", "summary": "The ID of the core definition associated with this version." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 1086 }, "name": "coreDefinitionId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-coredefinitionversion.html#cfn-greengrass-coredefinitionversion-cores" }, "remarks": "Currently, the `Cores` property for a core definition version can contain only one core.", "stability": "external", "summary": "The Greengrass core in this version." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 1093 }, "name": "cores", "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-greengrass.CfnCoreDefinitionVersion.CoreProperty" } ] } }, "kind": "array" } } ] } } } ], "symbolId": "lib/greengrass.generated:CfnCoreDefinitionVersionProps" }, "@aws-cdk/aws-greengrass.CfnDeviceDefinition": { "assembly": "@aws-cdk/aws-greengrass", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::Greengrass::DeviceDefinition", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-devicedefinition.html", "exampleMetadata": "fixture=_generated" }, "remarks": "The `AWS::Greengrass::DeviceDefinition` resource represents a device definition for AWS IoT Greengrass . Device definitions are used to organize your device definition versions.\n\nDevice 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.\n\n> 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.\n>\n> 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) .", "stability": "external", "summary": "A CloudFormation `AWS::Greengrass::DeviceDefinition`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as greengrass from '@aws-cdk/aws-greengrass';\n\ndeclare const tags: any;\nconst cfnDeviceDefinition = new greengrass.CfnDeviceDefinition(this, 'MyCfnDeviceDefinition', {\n name: 'name',\n\n // the properties below are optional\n initialVersion: {\n devices: [{\n certificateArn: 'certificateArn',\n id: 'id',\n thingArn: 'thingArn',\n\n // the properties below are optional\n syncShadow: false,\n }],\n },\n tags: tags,\n});" }, "fqn": "@aws-cdk/aws-greengrass.CfnDeviceDefinition", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::Greengrass::DeviceDefinition`." }, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 1532 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "@aws-cdk/aws-greengrass.CfnDeviceDefinitionProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 1446 }, "methods": [ { "docs": { "stability": "external", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 1551 }, "name": "inspect", "overrides": "@aws-cdk/core.IInspectable", "parameters": [ { "docs": { "summary": "- tree inspector to collect and process attributes." }, "name": "inspector", "type": { "fqn": "@aws-cdk/core.TreeInspector" } } ] }, { "docs": { "stability": "external" }, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 1564 }, "name": "renderProperties", "overrides": "@aws-cdk/core.CfnResource", "parameters": [ { "name": "props", "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } ], "protected": true, "returns": { "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } } ], "name": "CfnDeviceDefinition", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 1450 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "Arn" }, "stability": "external", "summary": "The Amazon Resource Name (ARN) of the `DeviceDefinition` , such as `arn:aws:greengrass:us-east-1: :/greengrass/definition/devices/1234a5b6-78cd-901e-2fgh-3i45j6k178l9` ." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 1475 }, "name": "attrArn", "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "Id" }, "stability": "external", "summary": "The ID of the `DeviceDefinition` , such as `1234a5b6-78cd-901e-2fgh-3i45j6k178l9` ." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 1481 }, "name": "attrId", "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "LatestVersionArn" }, "stability": "external", "summary": "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` ." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 1487 }, "name": "attrLatestVersionArn", "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "Name" }, "stability": "external", "summary": "The name of the device definition." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 1493 }, "name": "attrName", "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 1556 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-devicedefinition.html#cfn-greengrass-devicedefinition-tags" }, "remarks": "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* .\n\nThis `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.\n\n```json\n\"Tags\": { \"KeyName0\": \"value\", \"KeyName1\": \"value\", \"KeyName2\": \"value\"\n}\n```", "stability": "external", "summary": "Application-specific metadata to attach to the device definition." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 1523 }, "name": "tags", "type": { "fqn": "@aws-cdk/core.TagManager" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-devicedefinition.html#cfn-greengrass-devicedefinition-name" }, "stability": "external", "summary": "The name of the device definition." }, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 1500 }, "name": "name", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-devicedefinition.html#cfn-greengrass-devicedefinition-initialversion" }, "remarks": "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.\n\n> 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.", "stability": "external", "summary": "The device definition version to include when the device definition is created." }, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 1509 }, "name": "initialVersion", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-greengrass.CfnDeviceDefinition.DeviceDefinitionVersionProperty" } ] } } } ], "symbolId": "lib/greengrass.generated:CfnDeviceDefinition" }, "@aws-cdk/aws-greengrass.CfnDeviceDefinition.DeviceDefinitionVersionProperty": { "assembly": "@aws-cdk/aws-greengrass", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-devicedefinition-devicedefinitionversion.html", "exampleMetadata": "fixture=_generated" }, "remarks": "> 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) .\n\nIn 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.", "stability": "external", "summary": "A device definition version contains a list of [devices](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-devicedefinition-device.html) .", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as greengrass from '@aws-cdk/aws-greengrass';\nconst deviceDefinitionVersionProperty: greengrass.CfnDeviceDefinition.DeviceDefinitionVersionProperty = {\n devices: [{\n certificateArn: 'certificateArn',\n id: 'id',\n thingArn: 'thingArn',\n\n // the properties below are optional\n syncShadow: false,\n }],\n};" }, "fqn": "@aws-cdk/aws-greengrass.CfnDeviceDefinition.DeviceDefinitionVersionProperty", "kind": "interface", "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 1681 }, "name": "DeviceDefinitionVersionProperty", "namespace": "CfnDeviceDefinition", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-devicedefinition-devicedefinitionversion.html#cfn-greengrass-devicedefinition-devicedefinitionversion-devices" }, "stability": "external", "summary": "The devices in this version." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 1687 }, "name": "devices", "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-greengrass.CfnDeviceDefinition.DeviceProperty" } ] } }, "kind": "array" } } ] } } } ], "symbolId": "lib/greengrass.generated:CfnDeviceDefinition.DeviceDefinitionVersionProperty" }, "@aws-cdk/aws-greengrass.CfnDeviceDefinition.DeviceProperty": { "assembly": "@aws-cdk/aws-greengrass", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-devicedefinition-device.html", "exampleMetadata": "fixture=_generated" }, "remarks": "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* .\n\nIn 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.", "stability": "external", "summary": "A device is an AWS IoT device (thing) that's added to a Greengrass group.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as greengrass from '@aws-cdk/aws-greengrass';\nconst deviceProperty: greengrass.CfnDeviceDefinition.DeviceProperty = {\n certificateArn: 'certificateArn',\n id: 'id',\n thingArn: 'thingArn',\n\n // the properties below are optional\n syncShadow: false,\n};" }, "fqn": "@aws-cdk/aws-greengrass.CfnDeviceDefinition.DeviceProperty", "kind": "interface", "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 1580 }, "name": "DeviceProperty", "namespace": "CfnDeviceDefinition", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-devicedefinition-device.html#cfn-greengrass-devicedefinition-device-certificatearn" }, "remarks": "This X.509 certificate is used to authenticate the device with AWS IoT and AWS IoT Greengrass services.", "stability": "external", "summary": "The Amazon Resource Name (ARN) of the device certificate for the device." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 1586 }, "name": "certificateArn", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-devicedefinition-device.html#cfn-greengrass-devicedefinition-device-id" }, "remarks": "This value must be unique within the device definition version. Maximum length is 128 characters with pattern `[a-zA-Z0-9:_-]+` .", "stability": "external", "summary": "A descriptive or arbitrary ID for the device." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 1592 }, "name": "id", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-devicedefinition-device.html#cfn-greengrass-devicedefinition-device-thingarn" }, "stability": "external", "summary": "The ARN of the device, which is an AWS IoT device (thing)." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 1604 }, "name": "thingArn", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-devicedefinition-device.html#cfn-greengrass-devicedefinition-device-syncshadow" }, "stability": "external", "summary": "Indicates whether the device's local shadow is synced with the cloud automatically." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 1598 }, "name": "syncShadow", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } } ], "symbolId": "lib/greengrass.generated:CfnDeviceDefinition.DeviceProperty" }, "@aws-cdk/aws-greengrass.CfnDeviceDefinitionProps": { "assembly": "@aws-cdk/aws-greengrass", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-devicedefinition.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Properties for defining a `CfnDeviceDefinition`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as greengrass from '@aws-cdk/aws-greengrass';\n\ndeclare const tags: any;\nconst cfnDeviceDefinitionProps: greengrass.CfnDeviceDefinitionProps = {\n name: 'name',\n\n // the properties below are optional\n initialVersion: {\n devices: [{\n certificateArn: 'certificateArn',\n id: 'id',\n thingArn: 'thingArn',\n\n // the properties below are optional\n syncShadow: false,\n }],\n },\n tags: tags,\n};" }, "fqn": "@aws-cdk/aws-greengrass.CfnDeviceDefinitionProps", "kind": "interface", "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 1345 }, "name": "CfnDeviceDefinitionProps", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-devicedefinition.html#cfn-greengrass-devicedefinition-name" }, "stability": "external", "summary": "The name of the device definition." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 1352 }, "name": "name", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-devicedefinition.html#cfn-greengrass-devicedefinition-initialversion" }, "remarks": "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.\n\n> 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.", "stability": "external", "summary": "The device definition version to include when the device definition is created." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 1361 }, "name": "initialVersion", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-greengrass.CfnDeviceDefinition.DeviceDefinitionVersionProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-devicedefinition.html#cfn-greengrass-devicedefinition-tags" }, "remarks": "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* .\n\nThis `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.\n\n```json\n\"Tags\": { \"KeyName0\": \"value\", \"KeyName1\": \"value\", \"KeyName2\": \"value\"\n}\n```", "stability": "external", "summary": "Application-specific metadata to attach to the device definition." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 1375 }, "name": "tags", "optional": true, "type": { "primitive": "any" } } ], "symbolId": "lib/greengrass.generated:CfnDeviceDefinitionProps" }, "@aws-cdk/aws-greengrass.CfnDeviceDefinitionVersion": { "assembly": "@aws-cdk/aws-greengrass", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::Greengrass::DeviceDefinitionVersion", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-devicedefinitionversion.html", "exampleMetadata": "fixture=_generated" }, "remarks": "The `AWS::Greengrass::DeviceDefinitionVersion` resource represents a device definition version for AWS IoT Greengrass . A device definition version contains a list of devices.\n\n> 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) .\n>\n> 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) .", "stability": "external", "summary": "A CloudFormation `AWS::Greengrass::DeviceDefinitionVersion`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as greengrass from '@aws-cdk/aws-greengrass';\nconst cfnDeviceDefinitionVersion = new greengrass.CfnDeviceDefinitionVersion(this, 'MyCfnDeviceDefinitionVersion', {\n deviceDefinitionId: 'deviceDefinitionId',\n devices: [{\n certificateArn: 'certificateArn',\n id: 'id',\n thingArn: 'thingArn',\n\n // the properties below are optional\n syncShadow: false,\n }],\n});" }, "fqn": "@aws-cdk/aws-greengrass.CfnDeviceDefinitionVersion", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::Greengrass::DeviceDefinitionVersion`." }, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 1875 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "@aws-cdk/aws-greengrass.CfnDeviceDefinitionVersionProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 1829 }, "methods": [ { "docs": { "stability": "external", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 1890 }, "name": "inspect", "overrides": "@aws-cdk/core.IInspectable", "parameters": [ { "docs": { "summary": "- tree inspector to collect and process attributes." }, "name": "inspector", "type": { "fqn": "@aws-cdk/core.TreeInspector" } } ] }, { "docs": { "stability": "external" }, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 1902 }, "name": "renderProperties", "overrides": "@aws-cdk/core.CfnResource", "parameters": [ { "name": "props", "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } ], "protected": true, "returns": { "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } } ], "name": "CfnDeviceDefinitionVersion", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 1833 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 1895 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-devicedefinitionversion.html#cfn-greengrass-devicedefinitionversion-devicedefinitionid" }, "remarks": "This value is a GUID.", "stability": "external", "summary": "The ID of the device definition associated with this version." }, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 1859 }, "name": "deviceDefinitionId", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-devicedefinitionversion.html#cfn-greengrass-devicedefinitionversion-devices" }, "stability": "external", "summary": "The devices in this version." }, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 1866 }, "name": "devices", "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-greengrass.CfnDeviceDefinitionVersion.DeviceProperty" } ] } }, "kind": "array" } } ] } } } ], "symbolId": "lib/greengrass.generated:CfnDeviceDefinitionVersion" }, "@aws-cdk/aws-greengrass.CfnDeviceDefinitionVersion.DeviceProperty": { "assembly": "@aws-cdk/aws-greengrass", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-devicedefinitionversion-device.html", "exampleMetadata": "fixture=_generated" }, "remarks": "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* .\n\nIn 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.", "stability": "external", "summary": "A device is an AWS IoT device (thing) that's added to a Greengrass group.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as greengrass from '@aws-cdk/aws-greengrass';\nconst deviceProperty: greengrass.CfnDeviceDefinitionVersion.DeviceProperty = {\n certificateArn: 'certificateArn',\n id: 'id',\n thingArn: 'thingArn',\n\n // the properties below are optional\n syncShadow: false,\n};" }, "fqn": "@aws-cdk/aws-greengrass.CfnDeviceDefinitionVersion.DeviceProperty", "kind": "interface", "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 1918 }, "name": "DeviceProperty", "namespace": "CfnDeviceDefinitionVersion", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-devicedefinitionversion-device.html#cfn-greengrass-devicedefinitionversion-device-certificatearn" }, "remarks": "This X.509 certificate is used to authenticate the device with AWS IoT and AWS IoT Greengrass services.", "stability": "external", "summary": "The ARN of the device certificate for the device." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 1924 }, "name": "certificateArn", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-devicedefinitionversion-device.html#cfn-greengrass-devicedefinitionversion-device-id" }, "remarks": "This value must be unique within the device definition version. Maximum length is 128 characters with pattern `[a-zA-Z0-9:_-]+` .", "stability": "external", "summary": "A descriptive or arbitrary ID for the device." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 1930 }, "name": "id", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-devicedefinitionversion-device.html#cfn-greengrass-devicedefinitionversion-device-thingarn" }, "stability": "external", "summary": "The Amazon Resource Name (ARN) of the device, which is an AWS IoT device (thing)." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 1942 }, "name": "thingArn", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-devicedefinitionversion-device.html#cfn-greengrass-devicedefinitionversion-device-syncshadow" }, "stability": "external", "summary": "Indicates whether the device's local shadow is synced with the cloud automatically." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 1936 }, "name": "syncShadow", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } } ], "symbolId": "lib/greengrass.generated:CfnDeviceDefinitionVersion.DeviceProperty" }, "@aws-cdk/aws-greengrass.CfnDeviceDefinitionVersionProps": { "assembly": "@aws-cdk/aws-greengrass", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-devicedefinitionversion.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Properties for defining a `CfnDeviceDefinitionVersion`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as greengrass from '@aws-cdk/aws-greengrass';\nconst cfnDeviceDefinitionVersionProps: greengrass.CfnDeviceDefinitionVersionProps = {\n deviceDefinitionId: 'deviceDefinitionId',\n devices: [{\n certificateArn: 'certificateArn',\n id: 'id',\n thingArn: 'thingArn',\n\n // the properties below are optional\n syncShadow: false,\n }],\n};" }, "fqn": "@aws-cdk/aws-greengrass.CfnDeviceDefinitionVersionProps", "kind": "interface", "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 1748 }, "name": "CfnDeviceDefinitionVersionProps", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-devicedefinitionversion.html#cfn-greengrass-devicedefinitionversion-devicedefinitionid" }, "remarks": "This value is a GUID.", "stability": "external", "summary": "The ID of the device definition associated with this version." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 1755 }, "name": "deviceDefinitionId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-devicedefinitionversion.html#cfn-greengrass-devicedefinitionversion-devices" }, "stability": "external", "summary": "The devices in this version." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 1762 }, "name": "devices", "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-greengrass.CfnDeviceDefinitionVersion.DeviceProperty" } ] } }, "kind": "array" } } ] } } } ], "symbolId": "lib/greengrass.generated:CfnDeviceDefinitionVersionProps" }, "@aws-cdk/aws-greengrass.CfnFunctionDefinition": { "assembly": "@aws-cdk/aws-greengrass", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::Greengrass::FunctionDefinition", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-functiondefinition.html", "exampleMetadata": "fixture=_generated" }, "remarks": "The `AWS::Greengrass::FunctionDefinition` resource represents a function definition for AWS IoT Greengrass . Function definitions are used to organize your function definition versions.\n\nFunction 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.\n\n> 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.\n>\n> 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) .", "stability": "external", "summary": "A CloudFormation `AWS::Greengrass::FunctionDefinition`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as greengrass from '@aws-cdk/aws-greengrass';\n\ndeclare const tags: any;\ndeclare const variables: any;\nconst cfnFunctionDefinition = new greengrass.CfnFunctionDefinition(this, 'MyCfnFunctionDefinition', {\n name: 'name',\n\n // the properties below are optional\n initialVersion: {\n functions: [{\n functionArn: 'functionArn',\n functionConfiguration: {\n encodingType: 'encodingType',\n environment: {\n accessSysfs: false,\n execution: {\n isolationMode: 'isolationMode',\n runAs: {\n gid: 123,\n uid: 123,\n },\n },\n resourceAccessPolicies: [{\n resourceId: 'resourceId',\n\n // the properties below are optional\n permission: 'permission',\n }],\n variables: variables,\n },\n execArgs: 'execArgs',\n executable: 'executable',\n memorySize: 123,\n pinned: false,\n timeout: 123,\n },\n id: 'id',\n }],\n\n // the properties below are optional\n defaultConfig: {\n execution: {\n isolationMode: 'isolationMode',\n runAs: {\n gid: 123,\n uid: 123,\n },\n },\n },\n },\n tags: tags,\n});" }, "fqn": "@aws-cdk/aws-greengrass.CfnFunctionDefinition", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::Greengrass::FunctionDefinition`." }, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 2201 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "@aws-cdk/aws-greengrass.CfnFunctionDefinitionProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 2115 }, "methods": [ { "docs": { "stability": "external", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 2220 }, "name": "inspect", "overrides": "@aws-cdk/core.IInspectable", "parameters": [ { "docs": { "summary": "- tree inspector to collect and process attributes." }, "name": "inspector", "type": { "fqn": "@aws-cdk/core.TreeInspector" } } ] }, { "docs": { "stability": "external" }, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 2233 }, "name": "renderProperties", "overrides": "@aws-cdk/core.CfnResource", "parameters": [ { "name": "props", "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } ], "protected": true, "returns": { "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } } ], "name": "CfnFunctionDefinition", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 2119 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "Arn" }, "stability": "external", "summary": "The Amazon Resource Name (ARN) of the `FunctionDefinition` , such as `arn:aws:greengrass:us-east-1: :/greengrass/definition/functions/1234a5b6-78cd-901e-2fgh-3i45j6k178l9` ." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 2144 }, "name": "attrArn", "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "Id" }, "stability": "external", "summary": "The ID of the `FunctionDefinition` , such as `1234a5b6-78cd-901e-2fgh-3i45j6k178l9` ." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 2150 }, "name": "attrId", "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "LatestVersionArn" }, "stability": "external", "summary": "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` ." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 2156 }, "name": "attrLatestVersionArn", "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "Name" }, "stability": "external", "summary": "The name of the `FunctionDefinition` , such as `MyFunctionDefinition` ." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 2162 }, "name": "attrName", "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 2225 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-functiondefinition.html#cfn-greengrass-functiondefinition-tags" }, "remarks": "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* .\n\nThis `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.\n\n```json\n\"Tags\": { \"KeyName0\": \"value\", \"KeyName1\": \"value\", \"KeyName2\": \"value\"\n}\n```", "stability": "external", "summary": "Application-specific metadata to attach to the function definition." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 2192 }, "name": "tags", "type": { "fqn": "@aws-cdk/core.TagManager" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-functiondefinition.html#cfn-greengrass-functiondefinition-name" }, "stability": "external", "summary": "The name of the function definition." }, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 2169 }, "name": "name", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-functiondefinition.html#cfn-greengrass-functiondefinition-initialversion" }, "remarks": "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.\n\n> 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.", "stability": "external", "summary": "The function definition version to include when the function definition is created." }, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 2178 }, "name": "initialVersion", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-greengrass.CfnFunctionDefinition.FunctionDefinitionVersionProperty" } ] } } } ], "symbolId": "lib/greengrass.generated:CfnFunctionDefinition" }, "@aws-cdk/aws-greengrass.CfnFunctionDefinition.DefaultConfigProperty": { "assembly": "@aws-cdk/aws-greengrass", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-defaultconfig.html", "exampleMetadata": "fixture=_generated" }, "remarks": "Individual Lambda functions can override these settings.\n\nIn 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.", "stability": "external", "summary": "The default configuration that applies to all Lambda functions in the function definition version.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as greengrass from '@aws-cdk/aws-greengrass';\nconst defaultConfigProperty: greengrass.CfnFunctionDefinition.DefaultConfigProperty = {\n execution: {\n isolationMode: 'isolationMode',\n runAs: {\n gid: 123,\n uid: 123,\n },\n },\n};" }, "fqn": "@aws-cdk/aws-greengrass.CfnFunctionDefinition.DefaultConfigProperty", "kind": "interface", "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 2249 }, "name": "DefaultConfigProperty", "namespace": "CfnFunctionDefinition", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-defaultconfig.html#cfn-greengrass-functiondefinition-defaultconfig-execution" }, "stability": "external", "summary": "Configuration settings for the Lambda execution environment on the AWS IoT Greengrass core." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 2255 }, "name": "execution", "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-greengrass.CfnFunctionDefinition.ExecutionProperty" } ] } } } ], "symbolId": "lib/greengrass.generated:CfnFunctionDefinition.DefaultConfigProperty" }, "@aws-cdk/aws-greengrass.CfnFunctionDefinition.EnvironmentProperty": { "assembly": "@aws-cdk/aws-greengrass", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-environment.html", "exampleMetadata": "fixture=_generated" }, "remarks": "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.", "stability": "external", "summary": "The environment configuration for a Lambda function on the AWS IoT Greengrass core.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as greengrass from '@aws-cdk/aws-greengrass';\n\ndeclare const variables: any;\nconst environmentProperty: greengrass.CfnFunctionDefinition.EnvironmentProperty = {\n accessSysfs: false,\n execution: {\n isolationMode: 'isolationMode',\n runAs: {\n gid: 123,\n uid: 123,\n },\n },\n resourceAccessPolicies: [{\n resourceId: 'resourceId',\n\n // the properties below are optional\n permission: 'permission',\n }],\n variables: variables,\n};" }, "fqn": "@aws-cdk/aws-greengrass.CfnFunctionDefinition.EnvironmentProperty", "kind": "interface", "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 2319 }, "name": "EnvironmentProperty", "namespace": "CfnFunctionDefinition", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-environment.html#cfn-greengrass-functiondefinition-environment-accesssysfs" }, "remarks": "> This property applies only to Lambda functions that run in a Greengrass container.", "stability": "external", "summary": "Indicates whether the function is allowed to access the `/sys` directory on the core device, which allows the read device information from `/sys` ." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 2327 }, "name": "accessSysfs", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-environment.html#cfn-greengrass-functiondefinition-environment-execution" }, "stability": "external", "summary": "Settings for the Lambda execution environment in AWS IoT Greengrass ." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 2333 }, "name": "execution", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-greengrass.CfnFunctionDefinition.ExecutionProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-environment.html#cfn-greengrass-functiondefinition-environment-resourceaccesspolicies" }, "remarks": "> This property applies only for Lambda functions that run in a Greengrass container.", "stability": "external", "summary": "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." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 2341 }, "name": "resourceAccessPolicies", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-greengrass.CfnFunctionDefinition.ResourceAccessPolicyProperty" } ] } }, "kind": "array" } } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-environment.html#cfn-greengrass-functiondefinition-environment-variables" }, "stability": "external", "summary": "Environment variables for the Lambda function." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 2347 }, "name": "variables", "optional": true, "type": { "primitive": "any" } } ], "symbolId": "lib/greengrass.generated:CfnFunctionDefinition.EnvironmentProperty" }, "@aws-cdk/aws-greengrass.CfnFunctionDefinition.ExecutionProperty": { "assembly": "@aws-cdk/aws-greengrass", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-execution.html", "exampleMetadata": "fixture=_generated" }, "remarks": "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.", "stability": "external", "summary": "Configuration settings for the Lambda execution environment on the AWS IoT Greengrass core.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as greengrass from '@aws-cdk/aws-greengrass';\nconst executionProperty: greengrass.CfnFunctionDefinition.ExecutionProperty = {\n isolationMode: 'isolationMode',\n runAs: {\n gid: 123,\n uid: 123,\n },\n};" }, "fqn": "@aws-cdk/aws-greengrass.CfnFunctionDefinition.ExecutionProperty", "kind": "interface", "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 2419 }, "name": "ExecutionProperty", "namespace": "CfnFunctionDefinition", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-execution.html#cfn-greengrass-functiondefinition-execution-isolationmode" }, "remarks": "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* .\n\n- 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.\n- 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.\n\n> We recommend that you run in a Greengrass container unless your business case requires that you run without containerization.", "stability": "external", "summary": "The containerization that the Lambda function runs in." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 2430 }, "name": "isolationMode", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-execution.html#cfn-greengrass-functiondefinition-execution-runas" }, "remarks": "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* .\n\n- 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.\n- 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.\n\n> 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) .", "stability": "external", "summary": "The user and group permissions used to run the Lambda function." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 2441 }, "name": "runAs", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-greengrass.CfnFunctionDefinition.RunAsProperty" } ] } } } ], "symbolId": "lib/greengrass.generated:CfnFunctionDefinition.ExecutionProperty" }, "@aws-cdk/aws-greengrass.CfnFunctionDefinition.FunctionConfigurationProperty": { "assembly": "@aws-cdk/aws-greengrass", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-functionconfiguration.html", "exampleMetadata": "fixture=_generated" }, "remarks": "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* .\n\nIn 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.", "stability": "external", "summary": "The group-specific configuration settings for a Lambda function.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as greengrass from '@aws-cdk/aws-greengrass';\n\ndeclare const variables: any;\nconst functionConfigurationProperty: greengrass.CfnFunctionDefinition.FunctionConfigurationProperty = {\n encodingType: 'encodingType',\n environment: {\n accessSysfs: false,\n execution: {\n isolationMode: 'isolationMode',\n runAs: {\n gid: 123,\n uid: 123,\n },\n },\n resourceAccessPolicies: [{\n resourceId: 'resourceId',\n\n // the properties below are optional\n permission: 'permission',\n }],\n variables: variables,\n },\n execArgs: 'execArgs',\n executable: 'executable',\n memorySize: 123,\n pinned: false,\n timeout: 123,\n};" }, "fqn": "@aws-cdk/aws-greengrass.CfnFunctionDefinition.FunctionConfigurationProperty", "kind": "interface", "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 2597 }, "name": "FunctionConfigurationProperty", "namespace": "CfnFunctionDefinition", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-functionconfiguration.html#cfn-greengrass-functiondefinition-functionconfiguration-encodingtype" }, "remarks": "Valid values are `json` (default) and `binary` .", "stability": "external", "summary": "The expected encoding type of the input payload for the function." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 2603 }, "name": "encodingType", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-functionconfiguration.html#cfn-greengrass-functiondefinition-functionconfiguration-environment" }, "stability": "external", "summary": "The environment configuration of the function." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 2609 }, "name": "environment", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-greengrass.CfnFunctionDefinition.EnvironmentProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-functionconfiguration.html#cfn-greengrass-functiondefinition-functionconfiguration-execargs" }, "stability": "external", "summary": "The execution arguments." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 2615 }, "name": "execArgs", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-functionconfiguration.html#cfn-greengrass-functiondefinition-functionconfiguration-executable" }, "stability": "external", "summary": "The name of the function executable." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 2621 }, "name": "executable", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-functionconfiguration.html#cfn-greengrass-functiondefinition-functionconfiguration-memorysize" }, "remarks": "> This property applies only to Lambda functions that run in a Greengrass container.", "stability": "external", "summary": "The memory size (in KB) required by the function." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 2629 }, "name": "memorySize", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-functionconfiguration.html#cfn-greengrass-functiondefinition-functionconfiguration-pinned" }, "remarks": "Pinned functions start when the core starts and process all requests in the same container. The default value is false.", "stability": "external", "summary": "Indicates whether the function is pinned (or *long-lived* )." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 2635 }, "name": "pinned", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-functionconfiguration.html#cfn-greengrass-functiondefinition-functionconfiguration-timeout" }, "remarks": "For pinned functions, this timeout applies for each request.", "stability": "external", "summary": "The allowed execution time (in seconds) after which the function should terminate." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 2641 }, "name": "timeout", "optional": true, "type": { "primitive": "number" } } ], "symbolId": "lib/greengrass.generated:CfnFunctionDefinition.FunctionConfigurationProperty" }, "@aws-cdk/aws-greengrass.CfnFunctionDefinition.FunctionDefinitionVersionProperty": { "assembly": "@aws-cdk/aws-greengrass", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-functiondefinitionversion.html", "exampleMetadata": "fixture=_generated" }, "remarks": "> 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) .\n\nIn 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.", "stability": "external", "summary": "A function definition version contains a list of functions.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as greengrass from '@aws-cdk/aws-greengrass';\n\ndeclare const variables: any;\nconst functionDefinitionVersionProperty: greengrass.CfnFunctionDefinition.FunctionDefinitionVersionProperty = {\n functions: [{\n functionArn: 'functionArn',\n functionConfiguration: {\n encodingType: 'encodingType',\n environment: {\n accessSysfs: false,\n execution: {\n isolationMode: 'isolationMode',\n runAs: {\n gid: 123,\n uid: 123,\n },\n },\n resourceAccessPolicies: [{\n resourceId: 'resourceId',\n\n // the properties below are optional\n permission: 'permission',\n }],\n variables: variables,\n },\n execArgs: 'execArgs',\n executable: 'executable',\n memorySize: 123,\n pinned: false,\n timeout: 123,\n },\n id: 'id',\n }],\n\n // the properties below are optional\n defaultConfig: {\n execution: {\n isolationMode: 'isolationMode',\n runAs: {\n gid: 123,\n uid: 123,\n },\n },\n },\n};" }, "fqn": "@aws-cdk/aws-greengrass.CfnFunctionDefinition.FunctionDefinitionVersionProperty", "kind": "interface", "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 2724 }, "name": "FunctionDefinitionVersionProperty", "namespace": "CfnFunctionDefinition", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-functiondefinitionversion.html#cfn-greengrass-functiondefinition-functiondefinitionversion-functions" }, "stability": "external", "summary": "The functions in this version." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 2736 }, "name": "functions", "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-greengrass.CfnFunctionDefinition.FunctionProperty" } ] } }, "kind": "array" } } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-functiondefinitionversion.html#cfn-greengrass-functiondefinition-functiondefinitionversion-defaultconfig" }, "remarks": "Individual Lambda functions can override these settings.", "stability": "external", "summary": "The default configuration that applies to all Lambda functions in the group." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 2730 }, "name": "defaultConfig", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-greengrass.CfnFunctionDefinition.DefaultConfigProperty" } ] } } } ], "symbolId": "lib/greengrass.generated:CfnFunctionDefinition.FunctionDefinitionVersionProperty" }, "@aws-cdk/aws-greengrass.CfnFunctionDefinition.FunctionProperty": { "assembly": "@aws-cdk/aws-greengrass", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-function.html", "exampleMetadata": "fixture=_generated" }, "remarks": "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* .\n\nIn 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.", "stability": "external", "summary": "A function is a Lambda function that's referenced from an AWS IoT Greengrass group.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as greengrass from '@aws-cdk/aws-greengrass';\n\ndeclare const variables: any;\nconst functionProperty: greengrass.CfnFunctionDefinition.FunctionProperty = {\n functionArn: 'functionArn',\n functionConfiguration: {\n encodingType: 'encodingType',\n environment: {\n accessSysfs: false,\n execution: {\n isolationMode: 'isolationMode',\n runAs: {\n gid: 123,\n uid: 123,\n },\n },\n resourceAccessPolicies: [{\n resourceId: 'resourceId',\n\n // the properties below are optional\n permission: 'permission',\n }],\n variables: variables,\n },\n execArgs: 'execArgs',\n executable: 'executable',\n memorySize: 123,\n pinned: false,\n timeout: 123,\n },\n id: 'id',\n};" }, "fqn": "@aws-cdk/aws-greengrass.CfnFunctionDefinition.FunctionProperty", "kind": "interface", "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 2507 }, "name": "FunctionProperty", "namespace": "CfnFunctionDefinition", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-function.html#cfn-greengrass-functiondefinition-function-functionarn" }, "stability": "external", "summary": "The Amazon Resource Name (ARN) of the alias (recommended) or version of the referenced Lambda function." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 2513 }, "name": "functionArn", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-function.html#cfn-greengrass-functiondefinition-function-functionconfiguration" }, "remarks": "These settings configure the function's behavior in the Greengrass group.", "stability": "external", "summary": "The group-specific settings of the Lambda function." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 2519 }, "name": "functionConfiguration", "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-greengrass.CfnFunctionDefinition.FunctionConfigurationProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-function.html#cfn-greengrass-functiondefinition-function-id" }, "remarks": "This value must be unique within the function definition version. Maximum length is 128 characters with pattern `[a-zA-Z0-9:_-]+` .", "stability": "external", "summary": "A descriptive or arbitrary ID for the function." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 2525 }, "name": "id", "type": { "primitive": "string" } } ], "symbolId": "lib/greengrass.generated:CfnFunctionDefinition.FunctionProperty" }, "@aws-cdk/aws-greengrass.CfnFunctionDefinition.ResourceAccessPolicyProperty": { "assembly": "@aws-cdk/aws-greengrass", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-resourceaccesspolicy.html", "exampleMetadata": "fixture=_generated" }, "remarks": "> This property applies only to Lambda functions that run in a Greengrass container.\n\nIn 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.", "stability": "external", "summary": "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.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as greengrass from '@aws-cdk/aws-greengrass';\nconst resourceAccessPolicyProperty: greengrass.CfnFunctionDefinition.ResourceAccessPolicyProperty = {\n resourceId: 'resourceId',\n\n // the properties below are optional\n permission: 'permission',\n};" }, "fqn": "@aws-cdk/aws-greengrass.CfnFunctionDefinition.ResourceAccessPolicyProperty", "kind": "interface", "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 2805 }, "name": "ResourceAccessPolicyProperty", "namespace": "CfnFunctionDefinition", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-resourceaccesspolicy.html#cfn-greengrass-functiondefinition-resourceaccesspolicy-resourceid" }, "remarks": "This ID is assigned to the resource when you create the resource definition.", "stability": "external", "summary": "The ID of the resource." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 2817 }, "name": "resourceId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-resourceaccesspolicy.html#cfn-greengrass-functiondefinition-resourceaccesspolicy-permission" }, "remarks": "Valid values are `ro` or `rw` .", "stability": "external", "summary": "The read-only or read-write access that the Lambda function has to the resource." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 2811 }, "name": "permission", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/greengrass.generated:CfnFunctionDefinition.ResourceAccessPolicyProperty" }, "@aws-cdk/aws-greengrass.CfnFunctionDefinition.RunAsProperty": { "assembly": "@aws-cdk/aws-greengrass", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-runas.html", "exampleMetadata": "fixture=_generated" }, "remarks": "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* .\n\n> 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) .\n\nIn 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.", "stability": "external", "summary": "The access identity whose permissions are used to run the Lambda function.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as greengrass from '@aws-cdk/aws-greengrass';\nconst runAsProperty: greengrass.CfnFunctionDefinition.RunAsProperty = {\n gid: 123,\n uid: 123,\n};" }, "fqn": "@aws-cdk/aws-greengrass.CfnFunctionDefinition.RunAsProperty", "kind": "interface", "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 2886 }, "name": "RunAsProperty", "namespace": "CfnFunctionDefinition", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-runas.html#cfn-greengrass-functiondefinition-runas-gid" }, "remarks": "You can use the `getent group` command on your core device to look up the group ID.", "stability": "external", "summary": "The group ID whose permissions are used to run the Lambda function." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 2892 }, "name": "gid", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-runas.html#cfn-greengrass-functiondefinition-runas-uid" }, "remarks": "You can use the `getent passwd` command on your core device to look up the user ID.", "stability": "external", "summary": "The user ID whose permissions are used to run the Lambda function." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 2898 }, "name": "uid", "optional": true, "type": { "primitive": "number" } } ], "symbolId": "lib/greengrass.generated:CfnFunctionDefinition.RunAsProperty" }, "@aws-cdk/aws-greengrass.CfnFunctionDefinitionProps": { "assembly": "@aws-cdk/aws-greengrass", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-functiondefinition.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Properties for defining a `CfnFunctionDefinition`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as greengrass from '@aws-cdk/aws-greengrass';\n\ndeclare const tags: any;\ndeclare const variables: any;\nconst cfnFunctionDefinitionProps: greengrass.CfnFunctionDefinitionProps = {\n name: 'name',\n\n // the properties below are optional\n initialVersion: {\n functions: [{\n functionArn: 'functionArn',\n functionConfiguration: {\n encodingType: 'encodingType',\n environment: {\n accessSysfs: false,\n execution: {\n isolationMode: 'isolationMode',\n runAs: {\n gid: 123,\n uid: 123,\n },\n },\n resourceAccessPolicies: [{\n resourceId: 'resourceId',\n\n // the properties below are optional\n permission: 'permission',\n }],\n variables: variables,\n },\n execArgs: 'execArgs',\n executable: 'executable',\n memorySize: 123,\n pinned: false,\n timeout: 123,\n },\n id: 'id',\n }],\n\n // the properties below are optional\n defaultConfig: {\n execution: {\n isolationMode: 'isolationMode',\n runAs: {\n gid: 123,\n uid: 123,\n },\n },\n },\n },\n tags: tags,\n};" }, "fqn": "@aws-cdk/aws-greengrass.CfnFunctionDefinitionProps", "kind": "interface", "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 2014 }, "name": "CfnFunctionDefinitionProps", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-functiondefinition.html#cfn-greengrass-functiondefinition-name" }, "stability": "external", "summary": "The name of the function definition." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 2021 }, "name": "name", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-functiondefinition.html#cfn-greengrass-functiondefinition-initialversion" }, "remarks": "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.\n\n> 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.", "stability": "external", "summary": "The function definition version to include when the function definition is created." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 2030 }, "name": "initialVersion", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-greengrass.CfnFunctionDefinition.FunctionDefinitionVersionProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-functiondefinition.html#cfn-greengrass-functiondefinition-tags" }, "remarks": "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* .\n\nThis `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.\n\n```json\n\"Tags\": { \"KeyName0\": \"value\", \"KeyName1\": \"value\", \"KeyName2\": \"value\"\n}\n```", "stability": "external", "summary": "Application-specific metadata to attach to the function definition." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 2044 }, "name": "tags", "optional": true, "type": { "primitive": "any" } } ], "symbolId": "lib/greengrass.generated:CfnFunctionDefinitionProps" }, "@aws-cdk/aws-greengrass.CfnFunctionDefinitionVersion": { "assembly": "@aws-cdk/aws-greengrass", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::Greengrass::FunctionDefinitionVersion", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-functiondefinitionversion.html", "exampleMetadata": "fixture=_generated" }, "remarks": "The `AWS::Greengrass::FunctionDefinitionVersion` resource represents a function definition version for AWS IoT Greengrass . A function definition version contains contain a list of functions.\n\n> 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) .\n>\n> 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) .", "stability": "external", "summary": "A CloudFormation `AWS::Greengrass::FunctionDefinitionVersion`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as greengrass from '@aws-cdk/aws-greengrass';\n\ndeclare const variables: any;\nconst cfnFunctionDefinitionVersion = new greengrass.CfnFunctionDefinitionVersion(this, 'MyCfnFunctionDefinitionVersion', {\n functionDefinitionId: 'functionDefinitionId',\n functions: [{\n functionArn: 'functionArn',\n functionConfiguration: {\n encodingType: 'encodingType',\n environment: {\n accessSysfs: false,\n execution: {\n isolationMode: 'isolationMode',\n runAs: {\n gid: 123,\n uid: 123,\n },\n },\n resourceAccessPolicies: [{\n resourceId: 'resourceId',\n\n // the properties below are optional\n permission: 'permission',\n }],\n variables: variables,\n },\n execArgs: 'execArgs',\n executable: 'executable',\n memorySize: 123,\n pinned: false,\n timeout: 123,\n },\n id: 'id',\n }],\n\n // the properties below are optional\n defaultConfig: {\n execution: {\n isolationMode: 'isolationMode',\n runAs: {\n gid: 123,\n uid: 123,\n },\n },\n },\n});" }, "fqn": "@aws-cdk/aws-greengrass.CfnFunctionDefinitionVersion", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::Greengrass::FunctionDefinitionVersion`." }, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 3105 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "@aws-cdk/aws-greengrass.CfnFunctionDefinitionVersionProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 3052 }, "methods": [ { "docs": { "stability": "external", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 3121 }, "name": "inspect", "overrides": "@aws-cdk/core.IInspectable", "parameters": [ { "docs": { "summary": "- tree inspector to collect and process attributes." }, "name": "inspector", "type": { "fqn": "@aws-cdk/core.TreeInspector" } } ] }, { "docs": { "stability": "external" }, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 3134 }, "name": "renderProperties", "overrides": "@aws-cdk/core.CfnResource", "parameters": [ { "name": "props", "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } ], "protected": true, "returns": { "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } } ], "name": "CfnFunctionDefinitionVersion", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 3056 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 3126 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-functiondefinitionversion.html#cfn-greengrass-functiondefinitionversion-functiondefinitionid" }, "remarks": "This value is a GUID.", "stability": "external", "summary": "The ID of the function definition associated with this version." }, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 3082 }, "name": "functionDefinitionId", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-functiondefinitionversion.html#cfn-greengrass-functiondefinitionversion-functions" }, "stability": "external", "summary": "The functions in this version." }, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 3089 }, "name": "functions", "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-greengrass.CfnFunctionDefinitionVersion.FunctionProperty" } ] } }, "kind": "array" } } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-functiondefinitionversion.html#cfn-greengrass-functiondefinitionversion-defaultconfig" }, "remarks": "Individual Lambda functions can override these settings.", "stability": "external", "summary": "The default configuration that applies to all Lambda functions in the group." }, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 3096 }, "name": "defaultConfig", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-greengrass.CfnFunctionDefinitionVersion.DefaultConfigProperty" } ] } } } ], "symbolId": "lib/greengrass.generated:CfnFunctionDefinitionVersion" }, "@aws-cdk/aws-greengrass.CfnFunctionDefinitionVersion.DefaultConfigProperty": { "assembly": "@aws-cdk/aws-greengrass", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-defaultconfig.html", "exampleMetadata": "fixture=_generated" }, "remarks": "Individual Lambda functions can override these settings.\n\nIn 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.", "stability": "external", "summary": "The default configuration that applies to all Lambda functions in the function definition version.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as greengrass from '@aws-cdk/aws-greengrass';\nconst defaultConfigProperty: greengrass.CfnFunctionDefinitionVersion.DefaultConfigProperty = {\n execution: {\n isolationMode: 'isolationMode',\n runAs: {\n gid: 123,\n uid: 123,\n },\n },\n};" }, "fqn": "@aws-cdk/aws-greengrass.CfnFunctionDefinitionVersion.DefaultConfigProperty", "kind": "interface", "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 3150 }, "name": "DefaultConfigProperty", "namespace": "CfnFunctionDefinitionVersion", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-defaultconfig.html#cfn-greengrass-functiondefinitionversion-defaultconfig-execution" }, "stability": "external", "summary": "Configuration settings for the Lambda execution environment on the AWS IoT Greengrass core." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 3156 }, "name": "execution", "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-greengrass.CfnFunctionDefinitionVersion.ExecutionProperty" } ] } } } ], "symbolId": "lib/greengrass.generated:CfnFunctionDefinitionVersion.DefaultConfigProperty" }, "@aws-cdk/aws-greengrass.CfnFunctionDefinitionVersion.EnvironmentProperty": { "assembly": "@aws-cdk/aws-greengrass", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-environment.html", "exampleMetadata": "fixture=_generated" }, "remarks": "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.", "stability": "external", "summary": "The environment configuration for a Lambda function on the AWS IoT Greengrass core.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as greengrass from '@aws-cdk/aws-greengrass';\n\ndeclare const variables: any;\nconst environmentProperty: greengrass.CfnFunctionDefinitionVersion.EnvironmentProperty = {\n accessSysfs: false,\n execution: {\n isolationMode: 'isolationMode',\n runAs: {\n gid: 123,\n uid: 123,\n },\n },\n resourceAccessPolicies: [{\n resourceId: 'resourceId',\n\n // the properties below are optional\n permission: 'permission',\n }],\n variables: variables,\n};" }, "fqn": "@aws-cdk/aws-greengrass.CfnFunctionDefinitionVersion.EnvironmentProperty", "kind": "interface", "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 3220 }, "name": "EnvironmentProperty", "namespace": "CfnFunctionDefinitionVersion", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-environment.html#cfn-greengrass-functiondefinitionversion-environment-accesssysfs" }, "remarks": "> This property applies only to Lambda functions that run in a Greengrass container.", "stability": "external", "summary": "Indicates whether the function is allowed to access the `/sys` directory on the core device, which allows the read device information from `/sys` ." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 3228 }, "name": "accessSysfs", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-environment.html#cfn-greengrass-functiondefinitionversion-environment-execution" }, "stability": "external", "summary": "Settings for the Lambda execution environment in AWS IoT Greengrass ." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 3234 }, "name": "execution", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-greengrass.CfnFunctionDefinitionVersion.ExecutionProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-environment.html#cfn-greengrass-functiondefinitionversion-environment-resourceaccesspolicies" }, "remarks": "> This property applies only to Lambda functions that run in a Greengrass container.", "stability": "external", "summary": "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." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 3242 }, "name": "resourceAccessPolicies", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-greengrass.CfnFunctionDefinitionVersion.ResourceAccessPolicyProperty" } ] } }, "kind": "array" } } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-environment.html#cfn-greengrass-functiondefinitionversion-environment-variables" }, "stability": "external", "summary": "Environment variables for the Lambda function." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 3248 }, "name": "variables", "optional": true, "type": { "primitive": "any" } } ], "symbolId": "lib/greengrass.generated:CfnFunctionDefinitionVersion.EnvironmentProperty" }, "@aws-cdk/aws-greengrass.CfnFunctionDefinitionVersion.ExecutionProperty": { "assembly": "@aws-cdk/aws-greengrass", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-execution.html", "exampleMetadata": "fixture=_generated" }, "remarks": "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.", "stability": "external", "summary": "Configuration settings for the Lambda execution environment on the AWS IoT Greengrass core.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as greengrass from '@aws-cdk/aws-greengrass';\nconst executionProperty: greengrass.CfnFunctionDefinitionVersion.ExecutionProperty = {\n isolationMode: 'isolationMode',\n runAs: {\n gid: 123,\n uid: 123,\n },\n};" }, "fqn": "@aws-cdk/aws-greengrass.CfnFunctionDefinitionVersion.ExecutionProperty", "kind": "interface", "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 3320 }, "name": "ExecutionProperty", "namespace": "CfnFunctionDefinitionVersion", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-execution.html#cfn-greengrass-functiondefinitionversion-execution-isolationmode" }, "remarks": "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* .\n\n- 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.\n- 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.\n\n> We recommend that you run in a Greengrass container unless your business case requires that you run without containerization.", "stability": "external", "summary": "The containerization that the Lambda function runs in." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 3331 }, "name": "isolationMode", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-execution.html#cfn-greengrass-functiondefinitionversion-execution-runas" }, "remarks": "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* .\n\n- 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.\n- 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.\n\n> 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) .", "stability": "external", "summary": "The user and group permissions used to run the Lambda function." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 3342 }, "name": "runAs", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-greengrass.CfnFunctionDefinitionVersion.RunAsProperty" } ] } } } ], "symbolId": "lib/greengrass.generated:CfnFunctionDefinitionVersion.ExecutionProperty" }, "@aws-cdk/aws-greengrass.CfnFunctionDefinitionVersion.FunctionConfigurationProperty": { "assembly": "@aws-cdk/aws-greengrass", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-functionconfiguration.html", "exampleMetadata": "fixture=_generated" }, "remarks": "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* .\n\nIn 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.", "stability": "external", "summary": "The group-specific configuration settings for a Lambda function.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as greengrass from '@aws-cdk/aws-greengrass';\n\ndeclare const variables: any;\nconst functionConfigurationProperty: greengrass.CfnFunctionDefinitionVersion.FunctionConfigurationProperty = {\n encodingType: 'encodingType',\n environment: {\n accessSysfs: false,\n execution: {\n isolationMode: 'isolationMode',\n runAs: {\n gid: 123,\n uid: 123,\n },\n },\n resourceAccessPolicies: [{\n resourceId: 'resourceId',\n\n // the properties below are optional\n permission: 'permission',\n }],\n variables: variables,\n },\n execArgs: 'execArgs',\n executable: 'executable',\n memorySize: 123,\n pinned: false,\n timeout: 123,\n};" }, "fqn": "@aws-cdk/aws-greengrass.CfnFunctionDefinitionVersion.FunctionConfigurationProperty", "kind": "interface", "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 3498 }, "name": "FunctionConfigurationProperty", "namespace": "CfnFunctionDefinitionVersion", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-functionconfiguration.html#cfn-greengrass-functiondefinitionversion-functionconfiguration-encodingtype" }, "remarks": "Valid values are `json` (default) and `binary` .", "stability": "external", "summary": "The expected encoding type of the input payload for the function." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 3504 }, "name": "encodingType", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-functionconfiguration.html#cfn-greengrass-functiondefinitionversion-functionconfiguration-environment" }, "stability": "external", "summary": "The environment configuration of the function." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 3510 }, "name": "environment", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-greengrass.CfnFunctionDefinitionVersion.EnvironmentProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-functionconfiguration.html#cfn-greengrass-functiondefinitionversion-functionconfiguration-execargs" }, "stability": "external", "summary": "The execution arguments." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 3516 }, "name": "execArgs", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-functionconfiguration.html#cfn-greengrass-functiondefinitionversion-functionconfiguration-executable" }, "stability": "external", "summary": "The name of the function executable." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 3522 }, "name": "executable", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-functionconfiguration.html#cfn-greengrass-functiondefinitionversion-functionconfiguration-memorysize" }, "remarks": "> This property applies only to Lambda functions that run in a Greengrass container.", "stability": "external", "summary": "The memory size (in KB) required by the function." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 3530 }, "name": "memorySize", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-functionconfiguration.html#cfn-greengrass-functiondefinitionversion-functionconfiguration-pinned" }, "remarks": "Pinned functions start when the core starts and process all requests in the same container. The default value is false.", "stability": "external", "summary": "Indicates whether the function is pinned (or *long-lived* )." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 3536 }, "name": "pinned", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-functionconfiguration.html#cfn-greengrass-functiondefinitionversion-functionconfiguration-timeout" }, "remarks": "For pinned functions, this timeout applies for each request.", "stability": "external", "summary": "The allowed execution time (in seconds) after which the function should terminate." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 3542 }, "name": "timeout", "optional": true, "type": { "primitive": "number" } } ], "symbolId": "lib/greengrass.generated:CfnFunctionDefinitionVersion.FunctionConfigurationProperty" }, "@aws-cdk/aws-greengrass.CfnFunctionDefinitionVersion.FunctionProperty": { "assembly": "@aws-cdk/aws-greengrass", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-function.html", "exampleMetadata": "fixture=_generated" }, "remarks": "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* .\n\nIn 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.", "stability": "external", "summary": "A function is a Lambda function that's referenced from an AWS IoT Greengrass group.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as greengrass from '@aws-cdk/aws-greengrass';\n\ndeclare const variables: any;\nconst functionProperty: greengrass.CfnFunctionDefinitionVersion.FunctionProperty = {\n functionArn: 'functionArn',\n functionConfiguration: {\n encodingType: 'encodingType',\n environment: {\n accessSysfs: false,\n execution: {\n isolationMode: 'isolationMode',\n runAs: {\n gid: 123,\n uid: 123,\n },\n },\n resourceAccessPolicies: [{\n resourceId: 'resourceId',\n\n // the properties below are optional\n permission: 'permission',\n }],\n variables: variables,\n },\n execArgs: 'execArgs',\n executable: 'executable',\n memorySize: 123,\n pinned: false,\n timeout: 123,\n },\n id: 'id',\n};" }, "fqn": "@aws-cdk/aws-greengrass.CfnFunctionDefinitionVersion.FunctionProperty", "kind": "interface", "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 3408 }, "name": "FunctionProperty", "namespace": "CfnFunctionDefinitionVersion", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-function.html#cfn-greengrass-functiondefinitionversion-function-functionarn" }, "stability": "external", "summary": "The Amazon Resource Name (ARN) of the alias (recommended) or version of the referenced Lambda function." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 3414 }, "name": "functionArn", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-function.html#cfn-greengrass-functiondefinitionversion-function-functionconfiguration" }, "remarks": "These settings configure the function's behavior in the Greengrass group.", "stability": "external", "summary": "The group-specific settings of the Lambda function." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 3420 }, "name": "functionConfiguration", "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-greengrass.CfnFunctionDefinitionVersion.FunctionConfigurationProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-function.html#cfn-greengrass-functiondefinitionversion-function-id" }, "remarks": "This value must be unique within the function definition version. Maximum length is 128 characters with pattern `[a-zA-Z0-9:_-]+` .", "stability": "external", "summary": "A descriptive or arbitrary ID for the function." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 3426 }, "name": "id", "type": { "primitive": "string" } } ], "symbolId": "lib/greengrass.generated:CfnFunctionDefinitionVersion.FunctionProperty" }, "@aws-cdk/aws-greengrass.CfnFunctionDefinitionVersion.ResourceAccessPolicyProperty": { "assembly": "@aws-cdk/aws-greengrass", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-resourceaccesspolicy.html", "exampleMetadata": "fixture=_generated" }, "remarks": "> This property applies only to Lambda functions that run in a Greengrass container.\n\nIn 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.", "stability": "external", "summary": "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.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as greengrass from '@aws-cdk/aws-greengrass';\nconst resourceAccessPolicyProperty: greengrass.CfnFunctionDefinitionVersion.ResourceAccessPolicyProperty = {\n resourceId: 'resourceId',\n\n // the properties below are optional\n permission: 'permission',\n};" }, "fqn": "@aws-cdk/aws-greengrass.CfnFunctionDefinitionVersion.ResourceAccessPolicyProperty", "kind": "interface", "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 3625 }, "name": "ResourceAccessPolicyProperty", "namespace": "CfnFunctionDefinitionVersion", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-resourceaccesspolicy.html#cfn-greengrass-functiondefinitionversion-resourceaccesspolicy-resourceid" }, "remarks": "This ID is assigned to the resource when you create the resource definition.", "stability": "external", "summary": "The ID of the resource." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 3637 }, "name": "resourceId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-resourceaccesspolicy.html#cfn-greengrass-functiondefinitionversion-resourceaccesspolicy-permission" }, "remarks": "Valid values are `ro` or `rw` .", "stability": "external", "summary": "The read-only or read-write access that the Lambda function has to the resource." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 3631 }, "name": "permission", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/greengrass.generated:CfnFunctionDefinitionVersion.ResourceAccessPolicyProperty" }, "@aws-cdk/aws-greengrass.CfnFunctionDefinitionVersion.RunAsProperty": { "assembly": "@aws-cdk/aws-greengrass", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-runas.html", "exampleMetadata": "fixture=_generated" }, "remarks": "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* .\n\n> 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) .\n\nIn 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.", "stability": "external", "summary": "The user and group permissions used to run the Lambda function.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as greengrass from '@aws-cdk/aws-greengrass';\nconst runAsProperty: greengrass.CfnFunctionDefinitionVersion.RunAsProperty = {\n gid: 123,\n uid: 123,\n};" }, "fqn": "@aws-cdk/aws-greengrass.CfnFunctionDefinitionVersion.RunAsProperty", "kind": "interface", "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 3706 }, "name": "RunAsProperty", "namespace": "CfnFunctionDefinitionVersion", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-runas.html#cfn-greengrass-functiondefinitionversion-runas-gid" }, "remarks": "You can use the `getent group` command on your core device to look up the group ID.", "stability": "external", "summary": "The group ID whose permissions are used to run the Lambda function." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 3712 }, "name": "gid", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-runas.html#cfn-greengrass-functiondefinitionversion-runas-uid" }, "remarks": "You can use the `getent passwd` command on your core device to look up the user ID.", "stability": "external", "summary": "The user ID whose permissions are used to run the Lambda function." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 3718 }, "name": "uid", "optional": true, "type": { "primitive": "number" } } ], "symbolId": "lib/greengrass.generated:CfnFunctionDefinitionVersion.RunAsProperty" }, "@aws-cdk/aws-greengrass.CfnFunctionDefinitionVersionProps": { "assembly": "@aws-cdk/aws-greengrass", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-functiondefinitionversion.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Properties for defining a `CfnFunctionDefinitionVersion`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as greengrass from '@aws-cdk/aws-greengrass';\n\ndeclare const variables: any;\nconst cfnFunctionDefinitionVersionProps: greengrass.CfnFunctionDefinitionVersionProps = {\n functionDefinitionId: 'functionDefinitionId',\n functions: [{\n functionArn: 'functionArn',\n functionConfiguration: {\n encodingType: 'encodingType',\n environment: {\n accessSysfs: false,\n execution: {\n isolationMode: 'isolationMode',\n runAs: {\n gid: 123,\n uid: 123,\n },\n },\n resourceAccessPolicies: [{\n resourceId: 'resourceId',\n\n // the properties below are optional\n permission: 'permission',\n }],\n variables: variables,\n },\n execArgs: 'execArgs',\n executable: 'executable',\n memorySize: 123,\n pinned: false,\n timeout: 123,\n },\n id: 'id',\n }],\n\n // the properties below are optional\n defaultConfig: {\n execution: {\n isolationMode: 'isolationMode',\n runAs: {\n gid: 123,\n uid: 123,\n },\n },\n },\n};" }, "fqn": "@aws-cdk/aws-greengrass.CfnFunctionDefinitionVersionProps", "kind": "interface", "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 2961 }, "name": "CfnFunctionDefinitionVersionProps", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-functiondefinitionversion.html#cfn-greengrass-functiondefinitionversion-functiondefinitionid" }, "remarks": "This value is a GUID.", "stability": "external", "summary": "The ID of the function definition associated with this version." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 2968 }, "name": "functionDefinitionId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-functiondefinitionversion.html#cfn-greengrass-functiondefinitionversion-functions" }, "stability": "external", "summary": "The functions in this version." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 2975 }, "name": "functions", "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-greengrass.CfnFunctionDefinitionVersion.FunctionProperty" } ] } }, "kind": "array" } } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-functiondefinitionversion.html#cfn-greengrass-functiondefinitionversion-defaultconfig" }, "remarks": "Individual Lambda functions can override these settings.", "stability": "external", "summary": "The default configuration that applies to all Lambda functions in the group." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 2982 }, "name": "defaultConfig", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-greengrass.CfnFunctionDefinitionVersion.DefaultConfigProperty" } ] } } } ], "symbolId": "lib/greengrass.generated:CfnFunctionDefinitionVersionProps" }, "@aws-cdk/aws-greengrass.CfnGroup": { "assembly": "@aws-cdk/aws-greengrass", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::Greengrass::Group", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html", "exampleMetadata": "fixture=_generated" }, "remarks": "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) .\n\n> 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* .\n\nThe `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.\n\nGroups 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.\n\nTo 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.\n\n> 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.\n>\n> 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).\n\n*Deploying a Group Version*\n\nAfter 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* .", "stability": "external", "summary": "A CloudFormation `AWS::Greengrass::Group`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as greengrass from '@aws-cdk/aws-greengrass';\n\ndeclare const tags: any;\nconst cfnGroup = new greengrass.CfnGroup(this, 'MyCfnGroup', {\n name: 'name',\n\n // the properties below are optional\n initialVersion: {\n connectorDefinitionVersionArn: 'connectorDefinitionVersionArn',\n coreDefinitionVersionArn: 'coreDefinitionVersionArn',\n deviceDefinitionVersionArn: 'deviceDefinitionVersionArn',\n functionDefinitionVersionArn: 'functionDefinitionVersionArn',\n loggerDefinitionVersionArn: 'loggerDefinitionVersionArn',\n resourceDefinitionVersionArn: 'resourceDefinitionVersionArn',\n subscriptionDefinitionVersionArn: 'subscriptionDefinitionVersionArn',\n },\n roleArn: 'roleArn',\n tags: tags,\n});" }, "fqn": "@aws-cdk/aws-greengrass.CfnGroup", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::Greengrass::Group`." }, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 4007 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "@aws-cdk/aws-greengrass.CfnGroupProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 3902 }, "methods": [ { "docs": { "stability": "external", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 4029 }, "name": "inspect", "overrides": "@aws-cdk/core.IInspectable", "parameters": [ { "docs": { "summary": "- tree inspector to collect and process attributes." }, "name": "inspector", "type": { "fqn": "@aws-cdk/core.TreeInspector" } } ] }, { "docs": { "stability": "external" }, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 4043 }, "name": "renderProperties", "overrides": "@aws-cdk/core.CfnResource", "parameters": [ { "name": "props", "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } ], "protected": true, "returns": { "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } } ], "name": "CfnGroup", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 3906 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "Arn" }, "stability": "external", "summary": "The ARN of the `Group` , such as `arn:aws:greengrass:us-east-1: :/greengrass/definition/groups/1234a5b6-78cd-901e-2fgh-3i45j6k178l9` ." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 3931 }, "name": "attrArn", "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "Id" }, "stability": "external", "summary": "The ID of the `Group` , such as `1234a5b6-78cd-901e-2fgh-3i45j6k178l9` ." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 3937 }, "name": "attrId", "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "LatestVersionArn" }, "stability": "external", "summary": "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` ." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 3943 }, "name": "attrLatestVersionArn", "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "Name" }, "stability": "external", "summary": "The name of the `Group` , such as `MyGroup` ." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 3949 }, "name": "attrName", "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "RoleArn" }, "stability": "external", "summary": "The ARN of the IAM role that's attached to the `Group` , such as `arn:aws:iam:: :role/role-name` ." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 3955 }, "name": "attrRoleArn", "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "RoleAttachedAt" }, "stability": "external", "summary": "The time (in milliseconds since the epoch) when the group role was attached to the `Group` ." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 3961 }, "name": "attrRoleAttachedAt", "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 4034 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html#cfn-greengrass-group-tags" }, "remarks": "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* .\n\nThis `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.\n\n```json\n\"Tags\": { \"KeyName0\": \"value\", \"KeyName1\": \"value\", \"KeyName2\": \"value\"\n}\n```", "stability": "external", "summary": "Application-specific metadata to attach to the group." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 3998 }, "name": "tags", "type": { "fqn": "@aws-cdk/core.TagManager" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html#cfn-greengrass-group-name" }, "stability": "external", "summary": "The name of the group." }, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 3968 }, "name": "name", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html#cfn-greengrass-group-initialversion" }, "remarks": "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.\n\n> 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.", "stability": "external", "summary": "The group version to include when the group is created." }, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 3977 }, "name": "initialVersion", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-greengrass.CfnGroup.GroupVersionProperty" } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html#cfn-greengrass-group-rolearn" }, "remarks": "This role contains the permissions that Lambda functions and connectors use to interact with other AWS services.", "stability": "external", "summary": "The Amazon Resource Name (ARN) of the IAM role attached to the group." }, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 3984 }, "name": "roleArn", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/greengrass.generated:CfnGroup" }, "@aws-cdk/aws-greengrass.CfnGroup.GroupVersionProperty": { "assembly": "@aws-cdk/aws-greengrass", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-group-groupversion.html", "exampleMetadata": "fixture=_generated" }, "remarks": "The group version must reference a core definition version that contains one core. Other version types are optionally included, depending on your business need.\n\nIn 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.", "stability": "external", "summary": "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.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as greengrass from '@aws-cdk/aws-greengrass';\nconst groupVersionProperty: greengrass.CfnGroup.GroupVersionProperty = {\n connectorDefinitionVersionArn: 'connectorDefinitionVersionArn',\n coreDefinitionVersionArn: 'coreDefinitionVersionArn',\n deviceDefinitionVersionArn: 'deviceDefinitionVersionArn',\n functionDefinitionVersionArn: 'functionDefinitionVersionArn',\n loggerDefinitionVersionArn: 'loggerDefinitionVersionArn',\n resourceDefinitionVersionArn: 'resourceDefinitionVersionArn',\n subscriptionDefinitionVersionArn: 'subscriptionDefinitionVersionArn',\n};" }, "fqn": "@aws-cdk/aws-greengrass.CfnGroup.GroupVersionProperty", "kind": "interface", "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 4059 }, "name": "GroupVersionProperty", "namespace": "CfnGroup", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-group-groupversion.html#cfn-greengrass-group-groupversion-connectordefinitionversionarn" }, "stability": "external", "summary": "The Amazon Resource Name (ARN) of the connector definition version that contains the connectors you want to deploy with the group version." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 4065 }, "name": "connectorDefinitionVersionArn", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-group-groupversion.html#cfn-greengrass-group-groupversion-coredefinitionversionarn" }, "remarks": "Currently, the core definition version can contain only one core.", "stability": "external", "summary": "The ARN of the core definition version that contains the core you want to deploy with the group version." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 4071 }, "name": "coreDefinitionVersionArn", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-group-groupversion.html#cfn-greengrass-group-groupversion-devicedefinitionversionarn" }, "stability": "external", "summary": "The ARN of the device definition version that contains the devices you want to deploy with the group version." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 4077 }, "name": "deviceDefinitionVersionArn", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-group-groupversion.html#cfn-greengrass-group-groupversion-functiondefinitionversionarn" }, "stability": "external", "summary": "The ARN of the function definition version that contains the functions you want to deploy with the group version." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 4083 }, "name": "functionDefinitionVersionArn", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-group-groupversion.html#cfn-greengrass-group-groupversion-loggerdefinitionversionarn" }, "stability": "external", "summary": "The ARN of the logger definition version that contains the loggers you want to deploy with the group version." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 4089 }, "name": "loggerDefinitionVersionArn", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-group-groupversion.html#cfn-greengrass-group-groupversion-resourcedefinitionversionarn" }, "stability": "external", "summary": "The ARN of the resource definition version that contains the resources you want to deploy with the group version." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 4095 }, "name": "resourceDefinitionVersionArn", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-group-groupversion.html#cfn-greengrass-group-groupversion-subscriptiondefinitionversionarn" }, "stability": "external", "summary": "The ARN of the subscription definition version that contains the subscriptions you want to deploy with the group version." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 4101 }, "name": "subscriptionDefinitionVersionArn", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/greengrass.generated:CfnGroup.GroupVersionProperty" }, "@aws-cdk/aws-greengrass.CfnGroupProps": { "assembly": "@aws-cdk/aws-greengrass", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Properties for defining a `CfnGroup`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as greengrass from '@aws-cdk/aws-greengrass';\n\ndeclare const tags: any;\nconst cfnGroupProps: greengrass.CfnGroupProps = {\n name: 'name',\n\n // the properties below are optional\n initialVersion: {\n connectorDefinitionVersionArn: 'connectorDefinitionVersionArn',\n coreDefinitionVersionArn: 'coreDefinitionVersionArn',\n deviceDefinitionVersionArn: 'deviceDefinitionVersionArn',\n functionDefinitionVersionArn: 'functionDefinitionVersionArn',\n loggerDefinitionVersionArn: 'loggerDefinitionVersionArn',\n resourceDefinitionVersionArn: 'resourceDefinitionVersionArn',\n subscriptionDefinitionVersionArn: 'subscriptionDefinitionVersionArn',\n },\n roleArn: 'roleArn',\n tags: tags,\n};" }, "fqn": "@aws-cdk/aws-greengrass.CfnGroupProps", "kind": "interface", "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 3781 }, "name": "CfnGroupProps", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html#cfn-greengrass-group-name" }, "stability": "external", "summary": "The name of the group." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 3788 }, "name": "name", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html#cfn-greengrass-group-initialversion" }, "remarks": "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.\n\n> 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.", "stability": "external", "summary": "The group version to include when the group is created." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 3797 }, "name": "initialVersion", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-greengrass.CfnGroup.GroupVersionProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html#cfn-greengrass-group-rolearn" }, "remarks": "This role contains the permissions that Lambda functions and connectors use to interact with other AWS services.", "stability": "external", "summary": "The Amazon Resource Name (ARN) of the IAM role attached to the group." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 3804 }, "name": "roleArn", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html#cfn-greengrass-group-tags" }, "remarks": "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* .\n\nThis `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.\n\n```json\n\"Tags\": { \"KeyName0\": \"value\", \"KeyName1\": \"value\", \"KeyName2\": \"value\"\n}\n```", "stability": "external", "summary": "Application-specific metadata to attach to the group." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 3818 }, "name": "tags", "optional": true, "type": { "primitive": "any" } } ], "symbolId": "lib/greengrass.generated:CfnGroupProps" }, "@aws-cdk/aws-greengrass.CfnGroupVersion": { "assembly": "@aws-cdk/aws-greengrass", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::Greengrass::GroupVersion", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-groupversion.html", "exampleMetadata": "fixture=_generated" }, "remarks": "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.\n\n> 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) .", "stability": "external", "summary": "A CloudFormation `AWS::Greengrass::GroupVersion`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as greengrass from '@aws-cdk/aws-greengrass';\nconst cfnGroupVersion = new greengrass.CfnGroupVersion(this, 'MyCfnGroupVersion', {\n groupId: 'groupId',\n\n // the properties below are optional\n connectorDefinitionVersionArn: 'connectorDefinitionVersionArn',\n coreDefinitionVersionArn: 'coreDefinitionVersionArn',\n deviceDefinitionVersionArn: 'deviceDefinitionVersionArn',\n functionDefinitionVersionArn: 'functionDefinitionVersionArn',\n loggerDefinitionVersionArn: 'loggerDefinitionVersionArn',\n resourceDefinitionVersionArn: 'resourceDefinitionVersionArn',\n subscriptionDefinitionVersionArn: 'subscriptionDefinitionVersionArn',\n});" }, "fqn": "@aws-cdk/aws-greengrass.CfnGroupVersion", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::Greengrass::GroupVersion`." }, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 4405 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "@aws-cdk/aws-greengrass.CfnGroupVersionProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 4317 }, "methods": [ { "docs": { "stability": "external", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 4425 }, "name": "inspect", "overrides": "@aws-cdk/core.IInspectable", "parameters": [ { "docs": { "summary": "- tree inspector to collect and process attributes." }, "name": "inspector", "type": { "fqn": "@aws-cdk/core.TreeInspector" } } ] }, { "docs": { "stability": "external" }, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 4443 }, "name": "renderProperties", "overrides": "@aws-cdk/core.CfnResource", "parameters": [ { "name": "props", "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } ], "protected": true, "returns": { "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } } ], "name": "CfnGroupVersion", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 4321 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 4430 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-groupversion.html#cfn-greengrass-groupversion-groupid" }, "remarks": "This value is a GUID.", "stability": "external", "summary": "The ID of the group associated with this version." }, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 4347 }, "name": "groupId", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-groupversion.html#cfn-greengrass-groupversion-connectordefinitionversionarn" }, "stability": "external", "summary": "The Amazon Resource Name (ARN) of the connector definition version that contains the connectors you want to deploy with the group version." }, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 4354 }, "name": "connectorDefinitionVersionArn", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-groupversion.html#cfn-greengrass-groupversion-coredefinitionversionarn" }, "remarks": "Currently, the core definition version can contain only one core.", "stability": "external", "summary": "The ARN of the core definition version that contains the core you want to deploy with the group version." }, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 4361 }, "name": "coreDefinitionVersionArn", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-groupversion.html#cfn-greengrass-groupversion-devicedefinitionversionarn" }, "stability": "external", "summary": "The ARN of the device definition version that contains the devices you want to deploy with the group version." }, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 4368 }, "name": "deviceDefinitionVersionArn", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-groupversion.html#cfn-greengrass-groupversion-functiondefinitionversionarn" }, "stability": "external", "summary": "The ARN of the function definition version that contains the functions you want to deploy with the group version." }, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 4375 }, "name": "functionDefinitionVersionArn", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-groupversion.html#cfn-greengrass-groupversion-loggerdefinitionversionarn" }, "stability": "external", "summary": "The ARN of the logger definition version that contains the loggers you want to deploy with the group version." }, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 4382 }, "name": "loggerDefinitionVersionArn", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-groupversion.html#cfn-greengrass-groupversion-resourcedefinitionversionarn" }, "stability": "external", "summary": "The ARN of the resource definition version that contains the resources you want to deploy with the group version." }, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 4389 }, "name": "resourceDefinitionVersionArn", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-groupversion.html#cfn-greengrass-groupversion-subscriptiondefinitionversionarn" }, "stability": "external", "summary": "The ARN of the subscription definition version that contains the subscriptions you want to deploy with the group version." }, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 4396 }, "name": "subscriptionDefinitionVersionArn", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/greengrass.generated:CfnGroupVersion" }, "@aws-cdk/aws-greengrass.CfnGroupVersionProps": { "assembly": "@aws-cdk/aws-greengrass", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-groupversion.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Properties for defining a `CfnGroupVersion`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as greengrass from '@aws-cdk/aws-greengrass';\nconst cfnGroupVersionProps: greengrass.CfnGroupVersionProps = {\n groupId: 'groupId',\n\n // the properties below are optional\n connectorDefinitionVersionArn: 'connectorDefinitionVersionArn',\n coreDefinitionVersionArn: 'coreDefinitionVersionArn',\n deviceDefinitionVersionArn: 'deviceDefinitionVersionArn',\n functionDefinitionVersionArn: 'functionDefinitionVersionArn',\n loggerDefinitionVersionArn: 'loggerDefinitionVersionArn',\n resourceDefinitionVersionArn: 'resourceDefinitionVersionArn',\n subscriptionDefinitionVersionArn: 'subscriptionDefinitionVersionArn',\n};" }, "fqn": "@aws-cdk/aws-greengrass.CfnGroupVersionProps", "kind": "interface", "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 4179 }, "name": "CfnGroupVersionProps", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-groupversion.html#cfn-greengrass-groupversion-groupid" }, "remarks": "This value is a GUID.", "stability": "external", "summary": "The ID of the group associated with this version." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 4186 }, "name": "groupId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-groupversion.html#cfn-greengrass-groupversion-connectordefinitionversionarn" }, "stability": "external", "summary": "The Amazon Resource Name (ARN) of the connector definition version that contains the connectors you want to deploy with the group version." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 4193 }, "name": "connectorDefinitionVersionArn", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-groupversion.html#cfn-greengrass-groupversion-coredefinitionversionarn" }, "remarks": "Currently, the core definition version can contain only one core.", "stability": "external", "summary": "The ARN of the core definition version that contains the core you want to deploy with the group version." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 4200 }, "name": "coreDefinitionVersionArn", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-groupversion.html#cfn-greengrass-groupversion-devicedefinitionversionarn" }, "stability": "external", "summary": "The ARN of the device definition version that contains the devices you want to deploy with the group version." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 4207 }, "name": "deviceDefinitionVersionArn", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-groupversion.html#cfn-greengrass-groupversion-functiondefinitionversionarn" }, "stability": "external", "summary": "The ARN of the function definition version that contains the functions you want to deploy with the group version." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 4214 }, "name": "functionDefinitionVersionArn", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-groupversion.html#cfn-greengrass-groupversion-loggerdefinitionversionarn" }, "stability": "external", "summary": "The ARN of the logger definition version that contains the loggers you want to deploy with the group version." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 4221 }, "name": "loggerDefinitionVersionArn", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-groupversion.html#cfn-greengrass-groupversion-resourcedefinitionversionarn" }, "stability": "external", "summary": "The ARN of the resource definition version that contains the resources you want to deploy with the group version." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 4228 }, "name": "resourceDefinitionVersionArn", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-groupversion.html#cfn-greengrass-groupversion-subscriptiondefinitionversionarn" }, "stability": "external", "summary": "The ARN of the subscription definition version that contains the subscriptions you want to deploy with the group version." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 4235 }, "name": "subscriptionDefinitionVersionArn", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/greengrass.generated:CfnGroupVersionProps" }, "@aws-cdk/aws-greengrass.CfnLoggerDefinition": { "assembly": "@aws-cdk/aws-greengrass", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::Greengrass::LoggerDefinition", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-loggerdefinition.html", "exampleMetadata": "fixture=_generated" }, "remarks": "The `AWS::Greengrass::LoggerDefinition` resource represents a logger definition for AWS IoT Greengrass . Logger definitions are used to organize your logger definition versions.\n\nLogger 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.\n\n> 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.\n>\n> 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) .", "stability": "external", "summary": "A CloudFormation `AWS::Greengrass::LoggerDefinition`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as greengrass from '@aws-cdk/aws-greengrass';\n\ndeclare const tags: any;\nconst cfnLoggerDefinition = new greengrass.CfnLoggerDefinition(this, 'MyCfnLoggerDefinition', {\n name: 'name',\n\n // the properties below are optional\n initialVersion: {\n loggers: [{\n component: 'component',\n id: 'id',\n level: 'level',\n type: 'type',\n\n // the properties below are optional\n space: 123,\n }],\n },\n tags: tags,\n});" }, "fqn": "@aws-cdk/aws-greengrass.CfnLoggerDefinition", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::Greengrass::LoggerDefinition`." }, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 4643 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "@aws-cdk/aws-greengrass.CfnLoggerDefinitionProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 4557 }, "methods": [ { "docs": { "stability": "external", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 4662 }, "name": "inspect", "overrides": "@aws-cdk/core.IInspectable", "parameters": [ { "docs": { "summary": "- tree inspector to collect and process attributes." }, "name": "inspector", "type": { "fqn": "@aws-cdk/core.TreeInspector" } } ] }, { "docs": { "stability": "external" }, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 4675 }, "name": "renderProperties", "overrides": "@aws-cdk/core.CfnResource", "parameters": [ { "name": "props", "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } ], "protected": true, "returns": { "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } } ], "name": "CfnLoggerDefinition", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 4561 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "Arn" }, "stability": "external", "summary": "The Amazon Resource Name (ARN) of the `LoggerDefinition` , such as `arn:aws:greengrass:us-east-1: :/greengrass/definition/loggers/1234a5b6-78cd-901e-2fgh-3i45j6k178l9` ." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 4586 }, "name": "attrArn", "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "Id" }, "stability": "external", "summary": "The ID of the `LoggerDefinition` , such as `1234a5b6-78cd-901e-2fgh-3i45j6k178l9` ." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 4592 }, "name": "attrId", "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "LatestVersionArn" }, "stability": "external", "summary": "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` ." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 4598 }, "name": "attrLatestVersionArn", "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "Name" }, "stability": "external", "summary": "The name of the `LoggerDefinition` , such as `MyLoggerDefinition` ." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 4604 }, "name": "attrName", "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 4667 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-loggerdefinition.html#cfn-greengrass-loggerdefinition-tags" }, "remarks": "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* .\n\nThis `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.\n\n```json\n\"Tags\": { \"KeyName0\": \"value\", \"KeyName1\": \"value\", \"KeyName2\": \"value\"\n}\n```", "stability": "external", "summary": "Application-specific metadata to attach to the logger definition." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 4634 }, "name": "tags", "type": { "fqn": "@aws-cdk/core.TagManager" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-loggerdefinition.html#cfn-greengrass-loggerdefinition-name" }, "stability": "external", "summary": "The name of the logger definition." }, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 4611 }, "name": "name", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-loggerdefinition.html#cfn-greengrass-loggerdefinition-initialversion" }, "remarks": "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.\n\n> 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.", "stability": "external", "summary": "The logger definition version to include when the logger definition is created." }, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 4620 }, "name": "initialVersion", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-greengrass.CfnLoggerDefinition.LoggerDefinitionVersionProperty" } ] } } } ], "symbolId": "lib/greengrass.generated:CfnLoggerDefinition" }, "@aws-cdk/aws-greengrass.CfnLoggerDefinition.LoggerDefinitionVersionProperty": { "assembly": "@aws-cdk/aws-greengrass", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-loggerdefinition-loggerdefinitionversion.html", "exampleMetadata": "fixture=_generated" }, "remarks": "> 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) .\n\nIn 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.", "stability": "external", "summary": "A logger definition version contains a list of [loggers](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-loggerdefinition-logger.html) .", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as greengrass from '@aws-cdk/aws-greengrass';\nconst loggerDefinitionVersionProperty: greengrass.CfnLoggerDefinition.LoggerDefinitionVersionProperty = {\n loggers: [{\n component: 'component',\n id: 'id',\n level: 'level',\n type: 'type',\n\n // the properties below are optional\n space: 123,\n }],\n};" }, "fqn": "@aws-cdk/aws-greengrass.CfnLoggerDefinition.LoggerDefinitionVersionProperty", "kind": "interface", "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 4802 }, "name": "LoggerDefinitionVersionProperty", "namespace": "CfnLoggerDefinition", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-loggerdefinition-loggerdefinitionversion.html#cfn-greengrass-loggerdefinition-loggerdefinitionversion-loggers" }, "stability": "external", "summary": "The loggers in this version." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 4808 }, "name": "loggers", "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-greengrass.CfnLoggerDefinition.LoggerProperty" } ] } }, "kind": "array" } } ] } } } ], "symbolId": "lib/greengrass.generated:CfnLoggerDefinition.LoggerDefinitionVersionProperty" }, "@aws-cdk/aws-greengrass.CfnLoggerDefinition.LoggerProperty": { "assembly": "@aws-cdk/aws-greengrass", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-loggerdefinition-logger.html", "exampleMetadata": "fixture=_generated" }, "remarks": "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* .\n\nIn 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.", "stability": "external", "summary": "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.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as greengrass from '@aws-cdk/aws-greengrass';\nconst loggerProperty: greengrass.CfnLoggerDefinition.LoggerProperty = {\n component: 'component',\n id: 'id',\n level: 'level',\n type: 'type',\n\n // the properties below are optional\n space: 123,\n};" }, "fqn": "@aws-cdk/aws-greengrass.CfnLoggerDefinition.LoggerProperty", "kind": "interface", "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 4691 }, "name": "LoggerProperty", "namespace": "CfnLoggerDefinition", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-loggerdefinition-logger.html#cfn-greengrass-loggerdefinition-logger-component" }, "remarks": "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.", "stability": "external", "summary": "The source of the log event." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 4697 }, "name": "component", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-loggerdefinition-logger.html#cfn-greengrass-loggerdefinition-logger-id" }, "remarks": "This value must be unique within the logger definition version. Maximum length is 128 characters with pattern `[a-zA-Z0-9:_-]+` .", "stability": "external", "summary": "A descriptive or arbitrary ID for the logger." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 4703 }, "name": "id", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-loggerdefinition-logger.html#cfn-greengrass-loggerdefinition-logger-level" }, "remarks": "Log events below this threshold are filtered out and aren't stored. Valid values are `DEBUG` , `INFO` (recommended), `WARN` , `ERROR` , or `FATAL` .", "stability": "external", "summary": "The log-level threshold." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 4709 }, "name": "level", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-loggerdefinition-logger.html#cfn-greengrass-loggerdefinition-logger-type" }, "remarks": "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.", "stability": "external", "summary": "The storage mechanism for log events." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 4721 }, "name": "type", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-loggerdefinition-logger.html#cfn-greengrass-loggerdefinition-logger-space" }, "remarks": "This property does not apply for CloudWatch Logs .", "stability": "external", "summary": "The amount of file space (in KB) to use when writing logs to the local file system." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 4715 }, "name": "space", "optional": true, "type": { "primitive": "number" } } ], "symbolId": "lib/greengrass.generated:CfnLoggerDefinition.LoggerProperty" }, "@aws-cdk/aws-greengrass.CfnLoggerDefinitionProps": { "assembly": "@aws-cdk/aws-greengrass", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-loggerdefinition.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Properties for defining a `CfnLoggerDefinition`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as greengrass from '@aws-cdk/aws-greengrass';\n\ndeclare const tags: any;\nconst cfnLoggerDefinitionProps: greengrass.CfnLoggerDefinitionProps = {\n name: 'name',\n\n // the properties below are optional\n initialVersion: {\n loggers: [{\n component: 'component',\n id: 'id',\n level: 'level',\n type: 'type',\n\n // the properties below are optional\n space: 123,\n }],\n },\n tags: tags,\n};" }, "fqn": "@aws-cdk/aws-greengrass.CfnLoggerDefinitionProps", "kind": "interface", "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 4456 }, "name": "CfnLoggerDefinitionProps", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-loggerdefinition.html#cfn-greengrass-loggerdefinition-name" }, "stability": "external", "summary": "The name of the logger definition." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 4463 }, "name": "name", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-loggerdefinition.html#cfn-greengrass-loggerdefinition-initialversion" }, "remarks": "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.\n\n> 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.", "stability": "external", "summary": "The logger definition version to include when the logger definition is created." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 4472 }, "name": "initialVersion", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-greengrass.CfnLoggerDefinition.LoggerDefinitionVersionProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-loggerdefinition.html#cfn-greengrass-loggerdefinition-tags" }, "remarks": "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* .\n\nThis `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.\n\n```json\n\"Tags\": { \"KeyName0\": \"value\", \"KeyName1\": \"value\", \"KeyName2\": \"value\"\n}\n```", "stability": "external", "summary": "Application-specific metadata to attach to the logger definition." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 4486 }, "name": "tags", "optional": true, "type": { "primitive": "any" } } ], "symbolId": "lib/greengrass.generated:CfnLoggerDefinitionProps" }, "@aws-cdk/aws-greengrass.CfnLoggerDefinitionVersion": { "assembly": "@aws-cdk/aws-greengrass", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::Greengrass::LoggerDefinitionVersion", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-loggerdefinitionversion.html", "exampleMetadata": "fixture=_generated" }, "remarks": "The `AWS::Greengrass::LoggerDefinitionVersion` resource represents a logger definition version for AWS IoT Greengrass . A logger definition version contains a list of loggers.\n\n> 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) .\n>\n> 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) .", "stability": "external", "summary": "A CloudFormation `AWS::Greengrass::LoggerDefinitionVersion`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as greengrass from '@aws-cdk/aws-greengrass';\nconst cfnLoggerDefinitionVersion = new greengrass.CfnLoggerDefinitionVersion(this, 'MyCfnLoggerDefinitionVersion', {\n loggerDefinitionId: 'loggerDefinitionId',\n loggers: [{\n component: 'component',\n id: 'id',\n level: 'level',\n type: 'type',\n\n // the properties below are optional\n space: 123,\n }],\n});" }, "fqn": "@aws-cdk/aws-greengrass.CfnLoggerDefinitionVersion", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::Greengrass::LoggerDefinitionVersion`." }, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 4996 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "@aws-cdk/aws-greengrass.CfnLoggerDefinitionVersionProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 4950 }, "methods": [ { "docs": { "stability": "external", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 5011 }, "name": "inspect", "overrides": "@aws-cdk/core.IInspectable", "parameters": [ { "docs": { "summary": "- tree inspector to collect and process attributes." }, "name": "inspector", "type": { "fqn": "@aws-cdk/core.TreeInspector" } } ] }, { "docs": { "stability": "external" }, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 5023 }, "name": "renderProperties", "overrides": "@aws-cdk/core.CfnResource", "parameters": [ { "name": "props", "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } ], "protected": true, "returns": { "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } } ], "name": "CfnLoggerDefinitionVersion", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 4954 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 5016 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-loggerdefinitionversion.html#cfn-greengrass-loggerdefinitionversion-loggerdefinitionid" }, "remarks": "This value is a GUID.", "stability": "external", "summary": "The ID of the logger definition associated with this version." }, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 4980 }, "name": "loggerDefinitionId", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-loggerdefinitionversion.html#cfn-greengrass-loggerdefinitionversion-loggers" }, "stability": "external", "summary": "The loggers in this version." }, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 4987 }, "name": "loggers", "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-greengrass.CfnLoggerDefinitionVersion.LoggerProperty" } ] } }, "kind": "array" } } ] } } } ], "symbolId": "lib/greengrass.generated:CfnLoggerDefinitionVersion" }, "@aws-cdk/aws-greengrass.CfnLoggerDefinitionVersion.LoggerProperty": { "assembly": "@aws-cdk/aws-greengrass", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-loggerdefinitionversion-logger.html", "exampleMetadata": "fixture=_generated" }, "remarks": "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* .\n\nIn 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.", "stability": "external", "summary": "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.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as greengrass from '@aws-cdk/aws-greengrass';\nconst loggerProperty: greengrass.CfnLoggerDefinitionVersion.LoggerProperty = {\n component: 'component',\n id: 'id',\n level: 'level',\n type: 'type',\n\n // the properties below are optional\n space: 123,\n};" }, "fqn": "@aws-cdk/aws-greengrass.CfnLoggerDefinitionVersion.LoggerProperty", "kind": "interface", "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 5039 }, "name": "LoggerProperty", "namespace": "CfnLoggerDefinitionVersion", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-loggerdefinitionversion-logger.html#cfn-greengrass-loggerdefinitionversion-logger-component" }, "remarks": "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.", "stability": "external", "summary": "The source of the log event." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 5045 }, "name": "component", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-loggerdefinitionversion-logger.html#cfn-greengrass-loggerdefinitionversion-logger-id" }, "remarks": "This value must be unique within the logger definition version. Maximum length is 128 characters with pattern `[a-zA-Z0-9:_-]+` .", "stability": "external", "summary": "A descriptive or arbitrary ID for the logger." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 5051 }, "name": "id", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-loggerdefinitionversion-logger.html#cfn-greengrass-loggerdefinitionversion-logger-level" }, "remarks": "Log events below this threshold are filtered out and aren't stored. Valid values are `DEBUG` , `INFO` (recommended), `WARN` , `ERROR` , or `FATAL` .", "stability": "external", "summary": "The log-level threshold." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 5057 }, "name": "level", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-loggerdefinitionversion-logger.html#cfn-greengrass-loggerdefinitionversion-logger-type" }, "remarks": "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.", "stability": "external", "summary": "The storage mechanism for log events." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 5069 }, "name": "type", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-loggerdefinitionversion-logger.html#cfn-greengrass-loggerdefinitionversion-logger-space" }, "remarks": "This property does not apply for CloudWatch Logs .", "stability": "external", "summary": "The amount of file space (in KB) to use when writing logs to the local file system." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 5063 }, "name": "space", "optional": true, "type": { "primitive": "number" } } ], "symbolId": "lib/greengrass.generated:CfnLoggerDefinitionVersion.LoggerProperty" }, "@aws-cdk/aws-greengrass.CfnLoggerDefinitionVersionProps": { "assembly": "@aws-cdk/aws-greengrass", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-loggerdefinitionversion.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Properties for defining a `CfnLoggerDefinitionVersion`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as greengrass from '@aws-cdk/aws-greengrass';\nconst cfnLoggerDefinitionVersionProps: greengrass.CfnLoggerDefinitionVersionProps = {\n loggerDefinitionId: 'loggerDefinitionId',\n loggers: [{\n component: 'component',\n id: 'id',\n level: 'level',\n type: 'type',\n\n // the properties below are optional\n space: 123,\n }],\n};" }, "fqn": "@aws-cdk/aws-greengrass.CfnLoggerDefinitionVersionProps", "kind": "interface", "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 4869 }, "name": "CfnLoggerDefinitionVersionProps", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-loggerdefinitionversion.html#cfn-greengrass-loggerdefinitionversion-loggerdefinitionid" }, "remarks": "This value is a GUID.", "stability": "external", "summary": "The ID of the logger definition associated with this version." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 4876 }, "name": "loggerDefinitionId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-loggerdefinitionversion.html#cfn-greengrass-loggerdefinitionversion-loggers" }, "stability": "external", "summary": "The loggers in this version." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 4883 }, "name": "loggers", "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-greengrass.CfnLoggerDefinitionVersion.LoggerProperty" } ] } }, "kind": "array" } } ] } } } ], "symbolId": "lib/greengrass.generated:CfnLoggerDefinitionVersionProps" }, "@aws-cdk/aws-greengrass.CfnResourceDefinition": { "assembly": "@aws-cdk/aws-greengrass", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::Greengrass::ResourceDefinition", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-resourcedefinition.html", "exampleMetadata": "fixture=_generated" }, "remarks": "The `AWS::Greengrass::ResourceDefinition` resource represents a resource definition for AWS IoT Greengrass . Resource definitions are used to organize your resource definition versions.\n\nResource 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* .)\n\n> 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.\n>\n> 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) .", "stability": "external", "summary": "A CloudFormation `AWS::Greengrass::ResourceDefinition`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as greengrass from '@aws-cdk/aws-greengrass';\n\ndeclare const tags: any;\nconst cfnResourceDefinition = new greengrass.CfnResourceDefinition(this, 'MyCfnResourceDefinition', {\n name: 'name',\n\n // the properties below are optional\n initialVersion: {\n resources: [{\n id: 'id',\n name: 'name',\n resourceDataContainer: {\n localDeviceResourceData: {\n sourcePath: 'sourcePath',\n\n // the properties below are optional\n groupOwnerSetting: {\n autoAddGroupOwner: false,\n\n // the properties below are optional\n groupOwner: 'groupOwner',\n },\n },\n localVolumeResourceData: {\n destinationPath: 'destinationPath',\n sourcePath: 'sourcePath',\n\n // the properties below are optional\n groupOwnerSetting: {\n autoAddGroupOwner: false,\n\n // the properties below are optional\n groupOwner: 'groupOwner',\n },\n },\n s3MachineLearningModelResourceData: {\n destinationPath: 'destinationPath',\n s3Uri: 's3Uri',\n\n // the properties below are optional\n ownerSetting: {\n groupOwner: 'groupOwner',\n groupPermission: 'groupPermission',\n },\n },\n sageMakerMachineLearningModelResourceData: {\n destinationPath: 'destinationPath',\n sageMakerJobArn: 'sageMakerJobArn',\n\n // the properties below are optional\n ownerSetting: {\n groupOwner: 'groupOwner',\n groupPermission: 'groupPermission',\n },\n },\n secretsManagerSecretResourceData: {\n arn: 'arn',\n\n // the properties below are optional\n additionalStagingLabelsToDownload: ['additionalStagingLabelsToDownload'],\n },\n },\n }],\n },\n tags: tags,\n});" }, "fqn": "@aws-cdk/aws-greengrass.CfnResourceDefinition", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::Greengrass::ResourceDefinition`." }, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 5332 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "@aws-cdk/aws-greengrass.CfnResourceDefinitionProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 5246 }, "methods": [ { "docs": { "stability": "external", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 5351 }, "name": "inspect", "overrides": "@aws-cdk/core.IInspectable", "parameters": [ { "docs": { "summary": "- tree inspector to collect and process attributes." }, "name": "inspector", "type": { "fqn": "@aws-cdk/core.TreeInspector" } } ] }, { "docs": { "stability": "external" }, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 5364 }, "name": "renderProperties", "overrides": "@aws-cdk/core.CfnResource", "parameters": [ { "name": "props", "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } ], "protected": true, "returns": { "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } } ], "name": "CfnResourceDefinition", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 5250 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "Arn" }, "stability": "external", "summary": "The Amazon Resource Name (ARN) of the `ResourceDefinition` , such as `arn:aws:greengrass:us-east-1: :/greengrass/definition/resources/1234a5b6-78cd-901e-2fgh-3i45j6k178l9` ." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 5275 }, "name": "attrArn", "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "Id" }, "stability": "external", "summary": "The ID of the `ResourceDefinition` , such as `1234a5b6-78cd-901e-2fgh-3i45j6k178l9` ." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 5281 }, "name": "attrId", "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "LatestVersionArn" }, "stability": "external", "summary": "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` ." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 5287 }, "name": "attrLatestVersionArn", "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "Name" }, "stability": "external", "summary": "The name of the `ResourceDefinition` , such as `MyResourceDefinition` ." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 5293 }, "name": "attrName", "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 5356 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-resourcedefinition.html#cfn-greengrass-resourcedefinition-tags" }, "remarks": "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* .\n\nThis `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.\n\n```json\n\"Tags\": { \"KeyName0\": \"value\", \"KeyName1\": \"value\", \"KeyName2\": \"value\"\n}\n```", "stability": "external", "summary": "Application-specific metadata to attach to the resource definition." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 5323 }, "name": "tags", "type": { "fqn": "@aws-cdk/core.TagManager" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-resourcedefinition.html#cfn-greengrass-resourcedefinition-name" }, "stability": "external", "summary": "The name of the resource definition." }, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 5300 }, "name": "name", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-resourcedefinition.html#cfn-greengrass-resourcedefinition-initialversion" }, "remarks": "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.\n\n> 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.", "stability": "external", "summary": "The resource definition version to include when the resource definition is created." }, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 5309 }, "name": "initialVersion", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-greengrass.CfnResourceDefinition.ResourceDefinitionVersionProperty" } ] } } } ], "symbolId": "lib/greengrass.generated:CfnResourceDefinition" }, "@aws-cdk/aws-greengrass.CfnResourceDefinition.GroupOwnerSettingProperty": { "assembly": "@aws-cdk/aws-greengrass", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-groupownersetting.html", "exampleMetadata": "fixture=_generated" }, "remarks": "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.\n\nIn 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.", "stability": "external", "summary": "Settings that define additional Linux OS group permissions to give to the Lambda function process.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as greengrass from '@aws-cdk/aws-greengrass';\nconst groupOwnerSettingProperty: greengrass.CfnResourceDefinition.GroupOwnerSettingProperty = {\n autoAddGroupOwner: false,\n\n // the properties below are optional\n groupOwner: 'groupOwner',\n};" }, "fqn": "@aws-cdk/aws-greengrass.CfnResourceDefinition.GroupOwnerSettingProperty", "kind": "interface", "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 5380 }, "name": "GroupOwnerSettingProperty", "namespace": "CfnResourceDefinition", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-groupownersetting.html#cfn-greengrass-resourcedefinition-groupownersetting-autoaddgroupowner" }, "remarks": "This gives the Lambda process the file access permissions of the Linux group.", "stability": "external", "summary": "Indicates whether to give the privileges of the Linux group that owns the resource to the Lambda process." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 5386 }, "name": "autoAddGroupOwner", "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-groupownersetting.html#cfn-greengrass-resourcedefinition-groupownersetting-groupowner" }, "remarks": "This value is ignored if `AutoAddGroupOwner` is true.", "stability": "external", "summary": "The name of the Linux group whose privileges you want to add to the Lambda process." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 5392 }, "name": "groupOwner", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/greengrass.generated:CfnResourceDefinition.GroupOwnerSettingProperty" }, "@aws-cdk/aws-greengrass.CfnResourceDefinition.LocalDeviceResourceDataProperty": { "assembly": "@aws-cdk/aws-greengrass", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-localdeviceresourcedata.html", "exampleMetadata": "fixture=_generated" }, "remarks": "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* .\n\nIn 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.", "stability": "external", "summary": "Settings for a local device resource, which represents a file under `/dev` .", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as greengrass from '@aws-cdk/aws-greengrass';\nconst localDeviceResourceDataProperty: greengrass.CfnResourceDefinition.LocalDeviceResourceDataProperty = {\n sourcePath: 'sourcePath',\n\n // the properties below are optional\n groupOwnerSetting: {\n autoAddGroupOwner: false,\n\n // the properties below are optional\n groupOwner: 'groupOwner',\n },\n};" }, "fqn": "@aws-cdk/aws-greengrass.CfnResourceDefinition.LocalDeviceResourceDataProperty", "kind": "interface", "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 5459 }, "name": "LocalDeviceResourceDataProperty", "namespace": "CfnResourceDefinition", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-localdeviceresourcedata.html#cfn-greengrass-resourcedefinition-localdeviceresourcedata-sourcepath" }, "remarks": "The source path for a device resource can refer only to a character device or block device under `/dev` .", "stability": "external", "summary": "The local absolute path of the device resource." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 5471 }, "name": "sourcePath", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-localdeviceresourcedata.html#cfn-greengrass-resourcedefinition-localdeviceresourcedata-groupownersetting" }, "stability": "external", "summary": "Settings that define additional Linux OS group permissions to give to the Lambda function process." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 5465 }, "name": "groupOwnerSetting", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-greengrass.CfnResourceDefinition.GroupOwnerSettingProperty" } ] } } } ], "symbolId": "lib/greengrass.generated:CfnResourceDefinition.LocalDeviceResourceDataProperty" }, "@aws-cdk/aws-greengrass.CfnResourceDefinition.LocalVolumeResourceDataProperty": { "assembly": "@aws-cdk/aws-greengrass", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-localvolumeresourcedata.html", "exampleMetadata": "fixture=_generated" }, "remarks": "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* .\n\nIn 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.", "stability": "external", "summary": "Settings for a local volume resource, which represents a file or directory on the root file system.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as greengrass from '@aws-cdk/aws-greengrass';\nconst localVolumeResourceDataProperty: greengrass.CfnResourceDefinition.LocalVolumeResourceDataProperty = {\n destinationPath: 'destinationPath',\n sourcePath: 'sourcePath',\n\n // the properties below are optional\n groupOwnerSetting: {\n autoAddGroupOwner: false,\n\n // the properties below are optional\n groupOwner: 'groupOwner',\n },\n};" }, "fqn": "@aws-cdk/aws-greengrass.CfnResourceDefinition.LocalVolumeResourceDataProperty", "kind": "interface", "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 5538 }, "name": "LocalVolumeResourceDataProperty", "namespace": "CfnResourceDefinition", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-localvolumeresourcedata.html#cfn-greengrass-resourcedefinition-localvolumeresourcedata-destinationpath" }, "stability": "external", "summary": "The absolute local path of the resource in the Lambda environment." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 5544 }, "name": "destinationPath", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-localvolumeresourcedata.html#cfn-greengrass-resourcedefinition-localvolumeresourcedata-sourcepath" }, "remarks": "The source path for a volume resource type cannot start with `/sys` .", "stability": "external", "summary": "The local absolute path of the volume resource on the host." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 5556 }, "name": "sourcePath", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-localvolumeresourcedata.html#cfn-greengrass-resourcedefinition-localvolumeresourcedata-groupownersetting" }, "stability": "external", "summary": "Settings that define additional Linux OS group permissions to give to the Lambda function process." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 5550 }, "name": "groupOwnerSetting", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-greengrass.CfnResourceDefinition.GroupOwnerSettingProperty" } ] } } } ], "symbolId": "lib/greengrass.generated:CfnResourceDefinition.LocalVolumeResourceDataProperty" }, "@aws-cdk/aws-greengrass.CfnResourceDefinition.ResourceDataContainerProperty": { "assembly": "@aws-cdk/aws-greengrass", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-resourcedatacontainer.html", "exampleMetadata": "fixture=_generated" }, "remarks": "The container takes only one of the following supported resource data types: `LocalDeviceResourceData` , `LocalVolumeResourceData` , `SageMakerMachineLearningModelResourceData` , `S3MachineLearningModelResourceData` , or `SecretsManagerSecretResourceData` .\n\n> Only one resource type can be defined for a `ResourceDataContainer` instance.\n\nIn 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.", "stability": "external", "summary": "A container for resource data, which defines the resource type.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as greengrass from '@aws-cdk/aws-greengrass';\nconst resourceDataContainerProperty: greengrass.CfnResourceDefinition.ResourceDataContainerProperty = {\n localDeviceResourceData: {\n sourcePath: 'sourcePath',\n\n // the properties below are optional\n groupOwnerSetting: {\n autoAddGroupOwner: false,\n\n // the properties below are optional\n groupOwner: 'groupOwner',\n },\n },\n localVolumeResourceData: {\n destinationPath: 'destinationPath',\n sourcePath: 'sourcePath',\n\n // the properties below are optional\n groupOwnerSetting: {\n autoAddGroupOwner: false,\n\n // the properties below are optional\n groupOwner: 'groupOwner',\n },\n },\n s3MachineLearningModelResourceData: {\n destinationPath: 'destinationPath',\n s3Uri: 's3Uri',\n\n // the properties below are optional\n ownerSetting: {\n groupOwner: 'groupOwner',\n groupPermission: 'groupPermission',\n },\n },\n sageMakerMachineLearningModelResourceData: {\n destinationPath: 'destinationPath',\n sageMakerJobArn: 'sageMakerJobArn',\n\n // the properties below are optional\n ownerSetting: {\n groupOwner: 'groupOwner',\n groupPermission: 'groupPermission',\n },\n },\n secretsManagerSecretResourceData: {\n arn: 'arn',\n\n // the properties below are optional\n additionalStagingLabelsToDownload: ['additionalStagingLabelsToDownload'],\n },\n};" }, "fqn": "@aws-cdk/aws-greengrass.CfnResourceDefinition.ResourceDataContainerProperty", "kind": "interface", "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 5629 }, "name": "ResourceDataContainerProperty", "namespace": "CfnResourceDefinition", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-resourcedatacontainer.html#cfn-greengrass-resourcedefinition-resourcedatacontainer-localdeviceresourcedata" }, "stability": "external", "summary": "Settings for a local device resource." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 5635 }, "name": "localDeviceResourceData", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-greengrass.CfnResourceDefinition.LocalDeviceResourceDataProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-resourcedatacontainer.html#cfn-greengrass-resourcedefinition-resourcedatacontainer-localvolumeresourcedata" }, "stability": "external", "summary": "Settings for a local volume resource." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 5641 }, "name": "localVolumeResourceData", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-greengrass.CfnResourceDefinition.LocalVolumeResourceDataProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-resourcedatacontainer.html#cfn-greengrass-resourcedefinition-resourcedatacontainer-s3machinelearningmodelresourcedata" }, "stability": "external", "summary": "Settings for a machine learning resource stored in Amazon S3 ." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 5647 }, "name": "s3MachineLearningModelResourceData", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-greengrass.CfnResourceDefinition.S3MachineLearningModelResourceDataProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-resourcedatacontainer.html#cfn-greengrass-resourcedefinition-resourcedatacontainer-sagemakermachinelearningmodelresourcedata" }, "stability": "external", "summary": "Settings for a machine learning resource saved as an SageMaker training job." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 5653 }, "name": "sageMakerMachineLearningModelResourceData", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-greengrass.CfnResourceDefinition.SageMakerMachineLearningModelResourceDataProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-resourcedatacontainer.html#cfn-greengrass-resourcedefinition-resourcedatacontainer-secretsmanagersecretresourcedata" }, "stability": "external", "summary": "Settings for a secret resource." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 5659 }, "name": "secretsManagerSecretResourceData", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-greengrass.CfnResourceDefinition.SecretsManagerSecretResourceDataProperty" } ] } } } ], "symbolId": "lib/greengrass.generated:CfnResourceDefinition.ResourceDataContainerProperty" }, "@aws-cdk/aws-greengrass.CfnResourceDefinition.ResourceDefinitionVersionProperty": { "assembly": "@aws-cdk/aws-greengrass", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-resourcedefinitionversion.html", "exampleMetadata": "fixture=_generated" }, "remarks": "> 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) .\n\nIn 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.", "stability": "external", "summary": "A resource definition version contains a list of resources. (In AWS CloudFormation , resources are named *resource instances* .).", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as greengrass from '@aws-cdk/aws-greengrass';\nconst resourceDefinitionVersionProperty: greengrass.CfnResourceDefinition.ResourceDefinitionVersionProperty = {\n resources: [{\n id: 'id',\n name: 'name',\n resourceDataContainer: {\n localDeviceResourceData: {\n sourcePath: 'sourcePath',\n\n // the properties below are optional\n groupOwnerSetting: {\n autoAddGroupOwner: false,\n\n // the properties below are optional\n groupOwner: 'groupOwner',\n },\n },\n localVolumeResourceData: {\n destinationPath: 'destinationPath',\n sourcePath: 'sourcePath',\n\n // the properties below are optional\n groupOwnerSetting: {\n autoAddGroupOwner: false,\n\n // the properties below are optional\n groupOwner: 'groupOwner',\n },\n },\n s3MachineLearningModelResourceData: {\n destinationPath: 'destinationPath',\n s3Uri: 's3Uri',\n\n // the properties below are optional\n ownerSetting: {\n groupOwner: 'groupOwner',\n groupPermission: 'groupPermission',\n },\n },\n sageMakerMachineLearningModelResourceData: {\n destinationPath: 'destinationPath',\n sageMakerJobArn: 'sageMakerJobArn',\n\n // the properties below are optional\n ownerSetting: {\n groupOwner: 'groupOwner',\n groupPermission: 'groupPermission',\n },\n },\n secretsManagerSecretResourceData: {\n arn: 'arn',\n\n // the properties below are optional\n additionalStagingLabelsToDownload: ['additionalStagingLabelsToDownload'],\n },\n },\n }],\n};" }, "fqn": "@aws-cdk/aws-greengrass.CfnResourceDefinition.ResourceDefinitionVersionProperty", "kind": "interface", "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 5736 }, "name": "ResourceDefinitionVersionProperty", "namespace": "CfnResourceDefinition", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-resourcedefinitionversion.html#cfn-greengrass-resourcedefinition-resourcedefinitionversion-resources" }, "stability": "external", "summary": "The resources in this version." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 5742 }, "name": "resources", "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-greengrass.CfnResourceDefinition.ResourceInstanceProperty" } ] } }, "kind": "array" } } ] } } } ], "symbolId": "lib/greengrass.generated:CfnResourceDefinition.ResourceDefinitionVersionProperty" }, "@aws-cdk/aws-greengrass.CfnResourceDefinition.ResourceDownloadOwnerSettingProperty": { "assembly": "@aws-cdk/aws-greengrass", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-resourcedownloadownersetting.html", "exampleMetadata": "fixture=_generated" }, "remarks": "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* .\n\nIn 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.", "stability": "external", "summary": "The owner setting for a downloaded machine learning resource.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as greengrass from '@aws-cdk/aws-greengrass';\nconst resourceDownloadOwnerSettingProperty: greengrass.CfnResourceDefinition.ResourceDownloadOwnerSettingProperty = {\n groupOwner: 'groupOwner',\n groupPermission: 'groupPermission',\n};" }, "fqn": "@aws-cdk/aws-greengrass.CfnResourceDefinition.ResourceDownloadOwnerSettingProperty", "kind": "interface", "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 5806 }, "name": "ResourceDownloadOwnerSettingProperty", "namespace": "CfnResourceDefinition", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-resourcedownloadownersetting.html#cfn-greengrass-resourcedefinition-resourcedownloadownersetting-groupowner" }, "remarks": "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.", "stability": "external", "summary": "The group owner of the machine learning resource." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 5812 }, "name": "groupOwner", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-resourcedownloadownersetting.html#cfn-greengrass-resourcedefinition-resourcedownloadownersetting-grouppermission" }, "remarks": "Valid values are `rw` (read-write) or `ro` (read-only).", "stability": "external", "summary": "The permissions that the group owner has to the machine learning resource." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 5818 }, "name": "groupPermission", "type": { "primitive": "string" } } ], "symbolId": "lib/greengrass.generated:CfnResourceDefinition.ResourceDownloadOwnerSettingProperty" }, "@aws-cdk/aws-greengrass.CfnResourceDefinition.ResourceInstanceProperty": { "assembly": "@aws-cdk/aws-greengrass", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-resourceinstance.html", "exampleMetadata": "fixture=_generated" }, "remarks": "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* .\n\nIn 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.", "stability": "external", "summary": "A local resource, machine learning resource, or secret resource.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as greengrass from '@aws-cdk/aws-greengrass';\nconst resourceInstanceProperty: greengrass.CfnResourceDefinition.ResourceInstanceProperty = {\n id: 'id',\n name: 'name',\n resourceDataContainer: {\n localDeviceResourceData: {\n sourcePath: 'sourcePath',\n\n // the properties below are optional\n groupOwnerSetting: {\n autoAddGroupOwner: false,\n\n // the properties below are optional\n groupOwner: 'groupOwner',\n },\n },\n localVolumeResourceData: {\n destinationPath: 'destinationPath',\n sourcePath: 'sourcePath',\n\n // the properties below are optional\n groupOwnerSetting: {\n autoAddGroupOwner: false,\n\n // the properties below are optional\n groupOwner: 'groupOwner',\n },\n },\n s3MachineLearningModelResourceData: {\n destinationPath: 'destinationPath',\n s3Uri: 's3Uri',\n\n // the properties below are optional\n ownerSetting: {\n groupOwner: 'groupOwner',\n groupPermission: 'groupPermission',\n },\n },\n sageMakerMachineLearningModelResourceData: {\n destinationPath: 'destinationPath',\n sageMakerJobArn: 'sageMakerJobArn',\n\n // the properties below are optional\n ownerSetting: {\n groupOwner: 'groupOwner',\n groupPermission: 'groupPermission',\n },\n },\n secretsManagerSecretResourceData: {\n arn: 'arn',\n\n // the properties below are optional\n additionalStagingLabelsToDownload: ['additionalStagingLabelsToDownload'],\n },\n },\n};" }, "fqn": "@aws-cdk/aws-greengrass.CfnResourceDefinition.ResourceInstanceProperty", "kind": "interface", "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 5886 }, "name": "ResourceInstanceProperty", "namespace": "CfnResourceDefinition", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-resourceinstance.html#cfn-greengrass-resourcedefinition-resourceinstance-id" }, "remarks": "This value must be unique within the resource definition version. Maximum length is 128 characters with pattern `[a-zA-Z0-9:_-]+` .", "stability": "external", "summary": "A descriptive or arbitrary ID for the resource." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 5892 }, "name": "id", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-resourceinstance.html#cfn-greengrass-resourcedefinition-resourceinstance-name" }, "remarks": "Maximum length 128 characters with pattern [a-zA-Z0-9:_-]+. This must be unique within a Greengrass group.", "stability": "external", "summary": "The descriptive resource name, which is displayed on the AWS IoT Greengrass console." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 5898 }, "name": "name", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-resourceinstance.html#cfn-greengrass-resourcedefinition-resourceinstance-resourcedatacontainer" }, "remarks": "The container takes only one of the following supported resource data types: `LocalDeviceResourceData` , `LocalVolumeResourceData` , `SageMakerMachineLearningModelResourceData` , `S3MachineLearningModelResourceData` , or `SecretsManagerSecretResourceData` .\n\n> Only one resource type can be defined for a `ResourceDataContainer` instance.", "stability": "external", "summary": "A container for resource data." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 5906 }, "name": "resourceDataContainer", "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-greengrass.CfnResourceDefinition.ResourceDataContainerProperty" } ] } } } ], "symbolId": "lib/greengrass.generated:CfnResourceDefinition.ResourceInstanceProperty" }, "@aws-cdk/aws-greengrass.CfnResourceDefinition.S3MachineLearningModelResourceDataProperty": { "assembly": "@aws-cdk/aws-greengrass", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-s3machinelearningmodelresourcedata.html", "exampleMetadata": "fixture=_generated" }, "remarks": "For more information, see [Perform Machine Learning Inference](https://docs.aws.amazon.com/greengrass/latest/developerguide/ml-inference.html) in the *Developer Guide* .\n\nIn 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.", "stability": "external", "summary": "Settings for an Amazon S3 machine learning resource.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as greengrass from '@aws-cdk/aws-greengrass';\nconst s3MachineLearningModelResourceDataProperty: greengrass.CfnResourceDefinition.S3MachineLearningModelResourceDataProperty = {\n destinationPath: 'destinationPath',\n s3Uri: 's3Uri',\n\n // the properties below are optional\n ownerSetting: {\n groupOwner: 'groupOwner',\n groupPermission: 'groupPermission',\n },\n};" }, "fqn": "@aws-cdk/aws-greengrass.CfnResourceDefinition.S3MachineLearningModelResourceDataProperty", "kind": "interface", "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 5978 }, "name": "S3MachineLearningModelResourceDataProperty", "namespace": "CfnResourceDefinition", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-s3machinelearningmodelresourcedata.html#cfn-greengrass-resourcedefinition-s3machinelearningmodelresourcedata-destinationpath" }, "stability": "external", "summary": "The absolute local path of the resource inside the Lambda environment." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 5984 }, "name": "destinationPath", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-s3machinelearningmodelresourcedata.html#cfn-greengrass-resourcedefinition-s3machinelearningmodelresourcedata-s3uri" }, "remarks": "The model package must be in `tar.gz` or `.zip` format.", "stability": "external", "summary": "The URI of the source model in an Amazon S3 bucket." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 5996 }, "name": "s3Uri", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-s3machinelearningmodelresourcedata.html#cfn-greengrass-resourcedefinition-s3machinelearningmodelresourcedata-ownersetting" }, "remarks": "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* .", "stability": "external", "summary": "The owner setting for the downloaded machine learning resource." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 5990 }, "name": "ownerSetting", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-greengrass.CfnResourceDefinition.ResourceDownloadOwnerSettingProperty" } ] } } } ], "symbolId": "lib/greengrass.generated:CfnResourceDefinition.S3MachineLearningModelResourceDataProperty" }, "@aws-cdk/aws-greengrass.CfnResourceDefinition.SageMakerMachineLearningModelResourceDataProperty": { "assembly": "@aws-cdk/aws-greengrass", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-sagemakermachinelearningmodelresourcedata.html", "exampleMetadata": "fixture=_generated" }, "remarks": "For more information, see [Perform Machine Learning Inference](https://docs.aws.amazon.com/greengrass/latest/developerguide/ml-inference.html) in the *Developer Guide* .\n\nIn 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.", "stability": "external", "summary": "Settings for an Secrets Manager machine learning resource.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as greengrass from '@aws-cdk/aws-greengrass';\nconst sageMakerMachineLearningModelResourceDataProperty: greengrass.CfnResourceDefinition.SageMakerMachineLearningModelResourceDataProperty = {\n destinationPath: 'destinationPath',\n sageMakerJobArn: 'sageMakerJobArn',\n\n // the properties below are optional\n ownerSetting: {\n groupOwner: 'groupOwner',\n groupPermission: 'groupPermission',\n },\n};" }, "fqn": "@aws-cdk/aws-greengrass.CfnResourceDefinition.SageMakerMachineLearningModelResourceDataProperty", "kind": "interface", "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 6067 }, "name": "SageMakerMachineLearningModelResourceDataProperty", "namespace": "CfnResourceDefinition", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-sagemakermachinelearningmodelresourcedata.html#cfn-greengrass-resourcedefinition-sagemakermachinelearningmodelresourcedata-destinationpath" }, "stability": "external", "summary": "The absolute local path of the resource inside the Lambda environment." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 6073 }, "name": "destinationPath", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-sagemakermachinelearningmodelresourcedata.html#cfn-greengrass-resourcedefinition-sagemakermachinelearningmodelresourcedata-sagemakerjobarn" }, "stability": "external", "summary": "The Amazon Resource Name (ARN) of the Amazon SageMaker training job that represents the source model." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 6085 }, "name": "sageMakerJobArn", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-sagemakermachinelearningmodelresourcedata.html#cfn-greengrass-resourcedefinition-sagemakermachinelearningmodelresourcedata-ownersetting" }, "remarks": "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* .", "stability": "external", "summary": "The owner setting for the downloaded machine learning resource." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 6079 }, "name": "ownerSetting", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-greengrass.CfnResourceDefinition.ResourceDownloadOwnerSettingProperty" } ] } } } ], "symbolId": "lib/greengrass.generated:CfnResourceDefinition.SageMakerMachineLearningModelResourceDataProperty" }, "@aws-cdk/aws-greengrass.CfnResourceDefinition.SecretsManagerSecretResourceDataProperty": { "assembly": "@aws-cdk/aws-greengrass", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-secretsmanagersecretresourcedata.html", "exampleMetadata": "fixture=_generated" }, "remarks": "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* .\n\nIn 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.", "stability": "external", "summary": "Settings for a secret resource, which references a secret from AWS Secrets Manager .", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as greengrass from '@aws-cdk/aws-greengrass';\nconst secretsManagerSecretResourceDataProperty: greengrass.CfnResourceDefinition.SecretsManagerSecretResourceDataProperty = {\n arn: 'arn',\n\n // the properties below are optional\n additionalStagingLabelsToDownload: ['additionalStagingLabelsToDownload'],\n};" }, "fqn": "@aws-cdk/aws-greengrass.CfnResourceDefinition.SecretsManagerSecretResourceDataProperty", "kind": "interface", "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 6156 }, "name": "SecretsManagerSecretResourceDataProperty", "namespace": "CfnResourceDefinition", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-secretsmanagersecretresourcedata.html#cfn-greengrass-resourcedefinition-secretsmanagersecretresourcedata-arn" }, "remarks": "The value of the secret's latest version (represented by the `AWSCURRENT` staging label) is included by default.", "stability": "external", "summary": "The Amazon Resource Name (ARN) of the Secrets Manager secret to make available on the core." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 6162 }, "name": "arn", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-secretsmanagersecretresourcedata.html#cfn-greengrass-resourcedefinition-secretsmanagersecretresourcedata-additionalstaginglabelstodownload" }, "stability": "external", "summary": "The staging labels whose values you want to make available on the core, in addition to `AWSCURRENT` ." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 6168 }, "name": "additionalStagingLabelsToDownload", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } ], "symbolId": "lib/greengrass.generated:CfnResourceDefinition.SecretsManagerSecretResourceDataProperty" }, "@aws-cdk/aws-greengrass.CfnResourceDefinitionProps": { "assembly": "@aws-cdk/aws-greengrass", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-resourcedefinition.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Properties for defining a `CfnResourceDefinition`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as greengrass from '@aws-cdk/aws-greengrass';\n\ndeclare const tags: any;\nconst cfnResourceDefinitionProps: greengrass.CfnResourceDefinitionProps = {\n name: 'name',\n\n // the properties below are optional\n initialVersion: {\n resources: [{\n id: 'id',\n name: 'name',\n resourceDataContainer: {\n localDeviceResourceData: {\n sourcePath: 'sourcePath',\n\n // the properties below are optional\n groupOwnerSetting: {\n autoAddGroupOwner: false,\n\n // the properties below are optional\n groupOwner: 'groupOwner',\n },\n },\n localVolumeResourceData: {\n destinationPath: 'destinationPath',\n sourcePath: 'sourcePath',\n\n // the properties below are optional\n groupOwnerSetting: {\n autoAddGroupOwner: false,\n\n // the properties below are optional\n groupOwner: 'groupOwner',\n },\n },\n s3MachineLearningModelResourceData: {\n destinationPath: 'destinationPath',\n s3Uri: 's3Uri',\n\n // the properties below are optional\n ownerSetting: {\n groupOwner: 'groupOwner',\n groupPermission: 'groupPermission',\n },\n },\n sageMakerMachineLearningModelResourceData: {\n destinationPath: 'destinationPath',\n sageMakerJobArn: 'sageMakerJobArn',\n\n // the properties below are optional\n ownerSetting: {\n groupOwner: 'groupOwner',\n groupPermission: 'groupPermission',\n },\n },\n secretsManagerSecretResourceData: {\n arn: 'arn',\n\n // the properties below are optional\n additionalStagingLabelsToDownload: ['additionalStagingLabelsToDownload'],\n },\n },\n }],\n },\n tags: tags,\n};" }, "fqn": "@aws-cdk/aws-greengrass.CfnResourceDefinitionProps", "kind": "interface", "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 5145 }, "name": "CfnResourceDefinitionProps", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-resourcedefinition.html#cfn-greengrass-resourcedefinition-name" }, "stability": "external", "summary": "The name of the resource definition." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 5152 }, "name": "name", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-resourcedefinition.html#cfn-greengrass-resourcedefinition-initialversion" }, "remarks": "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.\n\n> 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.", "stability": "external", "summary": "The resource definition version to include when the resource definition is created." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 5161 }, "name": "initialVersion", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-greengrass.CfnResourceDefinition.ResourceDefinitionVersionProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-resourcedefinition.html#cfn-greengrass-resourcedefinition-tags" }, "remarks": "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* .\n\nThis `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.\n\n```json\n\"Tags\": { \"KeyName0\": \"value\", \"KeyName1\": \"value\", \"KeyName2\": \"value\"\n}\n```", "stability": "external", "summary": "Application-specific metadata to attach to the resource definition." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 5175 }, "name": "tags", "optional": true, "type": { "primitive": "any" } } ], "symbolId": "lib/greengrass.generated:CfnResourceDefinitionProps" }, "@aws-cdk/aws-greengrass.CfnResourceDefinitionVersion": { "assembly": "@aws-cdk/aws-greengrass", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::Greengrass::ResourceDefinitionVersion", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-resourcedefinitionversion.html", "exampleMetadata": "fixture=_generated" }, "remarks": "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* .)\n\n> 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) .\n>\n> 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) .", "stability": "external", "summary": "A CloudFormation `AWS::Greengrass::ResourceDefinitionVersion`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as greengrass from '@aws-cdk/aws-greengrass';\nconst cfnResourceDefinitionVersion = new greengrass.CfnResourceDefinitionVersion(this, 'MyCfnResourceDefinitionVersion', {\n resourceDefinitionId: 'resourceDefinitionId',\n resources: [{\n id: 'id',\n name: 'name',\n resourceDataContainer: {\n localDeviceResourceData: {\n sourcePath: 'sourcePath',\n\n // the properties below are optional\n groupOwnerSetting: {\n autoAddGroupOwner: false,\n\n // the properties below are optional\n groupOwner: 'groupOwner',\n },\n },\n localVolumeResourceData: {\n destinationPath: 'destinationPath',\n sourcePath: 'sourcePath',\n\n // the properties below are optional\n groupOwnerSetting: {\n autoAddGroupOwner: false,\n\n // the properties below are optional\n groupOwner: 'groupOwner',\n },\n },\n s3MachineLearningModelResourceData: {\n destinationPath: 'destinationPath',\n s3Uri: 's3Uri',\n\n // the properties below are optional\n ownerSetting: {\n groupOwner: 'groupOwner',\n groupPermission: 'groupPermission',\n },\n },\n sageMakerMachineLearningModelResourceData: {\n destinationPath: 'destinationPath',\n sageMakerJobArn: 'sageMakerJobArn',\n\n // the properties below are optional\n ownerSetting: {\n groupOwner: 'groupOwner',\n groupPermission: 'groupPermission',\n },\n },\n secretsManagerSecretResourceData: {\n arn: 'arn',\n\n // the properties below are optional\n additionalStagingLabelsToDownload: ['additionalStagingLabelsToDownload'],\n },\n },\n }],\n});" }, "fqn": "@aws-cdk/aws-greengrass.CfnResourceDefinitionVersion", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::Greengrass::ResourceDefinitionVersion`." }, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 6359 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "@aws-cdk/aws-greengrass.CfnResourceDefinitionVersionProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 6313 }, "methods": [ { "docs": { "stability": "external", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 6374 }, "name": "inspect", "overrides": "@aws-cdk/core.IInspectable", "parameters": [ { "docs": { "summary": "- tree inspector to collect and process attributes." }, "name": "inspector", "type": { "fqn": "@aws-cdk/core.TreeInspector" } } ] }, { "docs": { "stability": "external" }, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 6386 }, "name": "renderProperties", "overrides": "@aws-cdk/core.CfnResource", "parameters": [ { "name": "props", "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } ], "protected": true, "returns": { "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } } ], "name": "CfnResourceDefinitionVersion", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 6317 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 6379 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-resourcedefinitionversion.html#cfn-greengrass-resourcedefinitionversion-resourcedefinitionid" }, "remarks": "This value is a GUID.", "stability": "external", "summary": "The ID of the resource definition associated with this version." }, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 6343 }, "name": "resourceDefinitionId", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-resourcedefinitionversion.html#cfn-greengrass-resourcedefinitionversion-resources" }, "stability": "external", "summary": "The resources in this version." }, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 6350 }, "name": "resources", "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-greengrass.CfnResourceDefinitionVersion.ResourceInstanceProperty" } ] } }, "kind": "array" } } ] } } } ], "symbolId": "lib/greengrass.generated:CfnResourceDefinitionVersion" }, "@aws-cdk/aws-greengrass.CfnResourceDefinitionVersion.GroupOwnerSettingProperty": { "assembly": "@aws-cdk/aws-greengrass", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-groupownersetting.html", "exampleMetadata": "fixture=_generated" }, "remarks": "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.\n\nIn 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.", "stability": "external", "summary": "Settings that define additional Linux OS group permissions to give to the Lambda function process.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as greengrass from '@aws-cdk/aws-greengrass';\nconst groupOwnerSettingProperty: greengrass.CfnResourceDefinitionVersion.GroupOwnerSettingProperty = {\n autoAddGroupOwner: false,\n\n // the properties below are optional\n groupOwner: 'groupOwner',\n};" }, "fqn": "@aws-cdk/aws-greengrass.CfnResourceDefinitionVersion.GroupOwnerSettingProperty", "kind": "interface", "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 6402 }, "name": "GroupOwnerSettingProperty", "namespace": "CfnResourceDefinitionVersion", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-groupownersetting.html#cfn-greengrass-resourcedefinitionversion-groupownersetting-autoaddgroupowner" }, "remarks": "This gives the Lambda process the file access permissions of the Linux group.", "stability": "external", "summary": "Indicates whether to give the privileges of the Linux group that owns the resource to the Lambda process." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 6408 }, "name": "autoAddGroupOwner", "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-groupownersetting.html#cfn-greengrass-resourcedefinitionversion-groupownersetting-groupowner" }, "remarks": "This value is ignored if `AutoAddGroupOwner` is true.", "stability": "external", "summary": "The name of the Linux group whose privileges you want to add to the Lambda process." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 6414 }, "name": "groupOwner", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/greengrass.generated:CfnResourceDefinitionVersion.GroupOwnerSettingProperty" }, "@aws-cdk/aws-greengrass.CfnResourceDefinitionVersion.LocalDeviceResourceDataProperty": { "assembly": "@aws-cdk/aws-greengrass", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-localdeviceresourcedata.html", "exampleMetadata": "fixture=_generated" }, "remarks": "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* .\n\nIn 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.", "stability": "external", "summary": "Settings for a local device resource, which represents a file under `/dev` .", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as greengrass from '@aws-cdk/aws-greengrass';\nconst localDeviceResourceDataProperty: greengrass.CfnResourceDefinitionVersion.LocalDeviceResourceDataProperty = {\n sourcePath: 'sourcePath',\n\n // the properties below are optional\n groupOwnerSetting: {\n autoAddGroupOwner: false,\n\n // the properties below are optional\n groupOwner: 'groupOwner',\n },\n};" }, "fqn": "@aws-cdk/aws-greengrass.CfnResourceDefinitionVersion.LocalDeviceResourceDataProperty", "kind": "interface", "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 6481 }, "name": "LocalDeviceResourceDataProperty", "namespace": "CfnResourceDefinitionVersion", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-localdeviceresourcedata.html#cfn-greengrass-resourcedefinitionversion-localdeviceresourcedata-sourcepath" }, "remarks": "The source path for a device resource can refer only to a character device or block device under `/dev` .", "stability": "external", "summary": "The local absolute path of the device resource." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 6493 }, "name": "sourcePath", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-localdeviceresourcedata.html#cfn-greengrass-resourcedefinitionversion-localdeviceresourcedata-groupownersetting" }, "stability": "external", "summary": "Settings that define additional Linux OS group permissions to give to the Lambda function process." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 6487 }, "name": "groupOwnerSetting", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-greengrass.CfnResourceDefinitionVersion.GroupOwnerSettingProperty" } ] } } } ], "symbolId": "lib/greengrass.generated:CfnResourceDefinitionVersion.LocalDeviceResourceDataProperty" }, "@aws-cdk/aws-greengrass.CfnResourceDefinitionVersion.LocalVolumeResourceDataProperty": { "assembly": "@aws-cdk/aws-greengrass", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-localvolumeresourcedata.html", "exampleMetadata": "fixture=_generated" }, "remarks": "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* .\n\nIn 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.", "stability": "external", "summary": "Settings for a local volume resource, which represents a file or directory on the root file system.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as greengrass from '@aws-cdk/aws-greengrass';\nconst localVolumeResourceDataProperty: greengrass.CfnResourceDefinitionVersion.LocalVolumeResourceDataProperty = {\n destinationPath: 'destinationPath',\n sourcePath: 'sourcePath',\n\n // the properties below are optional\n groupOwnerSetting: {\n autoAddGroupOwner: false,\n\n // the properties below are optional\n groupOwner: 'groupOwner',\n },\n};" }, "fqn": "@aws-cdk/aws-greengrass.CfnResourceDefinitionVersion.LocalVolumeResourceDataProperty", "kind": "interface", "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 6560 }, "name": "LocalVolumeResourceDataProperty", "namespace": "CfnResourceDefinitionVersion", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-localvolumeresourcedata.html#cfn-greengrass-resourcedefinitionversion-localvolumeresourcedata-destinationpath" }, "stability": "external", "summary": "The absolute local path of the resource in the Lambda environment." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 6566 }, "name": "destinationPath", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-localvolumeresourcedata.html#cfn-greengrass-resourcedefinitionversion-localvolumeresourcedata-sourcepath" }, "remarks": "The source path for a volume resource type cannot start with `/sys` .", "stability": "external", "summary": "The local absolute path of the volume resource on the host." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 6578 }, "name": "sourcePath", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-localvolumeresourcedata.html#cfn-greengrass-resourcedefinitionversion-localvolumeresourcedata-groupownersetting" }, "stability": "external", "summary": "Settings that define additional Linux OS group permissions to give to the Lambda function process." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 6572 }, "name": "groupOwnerSetting", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-greengrass.CfnResourceDefinitionVersion.GroupOwnerSettingProperty" } ] } } } ], "symbolId": "lib/greengrass.generated:CfnResourceDefinitionVersion.LocalVolumeResourceDataProperty" }, "@aws-cdk/aws-greengrass.CfnResourceDefinitionVersion.ResourceDataContainerProperty": { "assembly": "@aws-cdk/aws-greengrass", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-resourcedatacontainer.html", "exampleMetadata": "fixture=_generated" }, "remarks": "The container takes only one of the following supported resource data types: `LocalDeviceResourceData` , `LocalVolumeResourceData` , `SageMakerMachineLearningModelResourceData` , `S3MachineLearningModelResourceData` , or `SecretsManagerSecretResourceData` .\n\n> Only one resource type can be defined for a `ResourceDataContainer` instance.\n\nIn 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.", "stability": "external", "summary": "A container for resource data, which defines the resource type.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as greengrass from '@aws-cdk/aws-greengrass';\nconst resourceDataContainerProperty: greengrass.CfnResourceDefinitionVersion.ResourceDataContainerProperty = {\n localDeviceResourceData: {\n sourcePath: 'sourcePath',\n\n // the properties below are optional\n groupOwnerSetting: {\n autoAddGroupOwner: false,\n\n // the properties below are optional\n groupOwner: 'groupOwner',\n },\n },\n localVolumeResourceData: {\n destinationPath: 'destinationPath',\n sourcePath: 'sourcePath',\n\n // the properties below are optional\n groupOwnerSetting: {\n autoAddGroupOwner: false,\n\n // the properties below are optional\n groupOwner: 'groupOwner',\n },\n },\n s3MachineLearningModelResourceData: {\n destinationPath: 'destinationPath',\n s3Uri: 's3Uri',\n\n // the properties below are optional\n ownerSetting: {\n groupOwner: 'groupOwner',\n groupPermission: 'groupPermission',\n },\n },\n sageMakerMachineLearningModelResourceData: {\n destinationPath: 'destinationPath',\n sageMakerJobArn: 'sageMakerJobArn',\n\n // the properties below are optional\n ownerSetting: {\n groupOwner: 'groupOwner',\n groupPermission: 'groupPermission',\n },\n },\n secretsManagerSecretResourceData: {\n arn: 'arn',\n\n // the properties below are optional\n additionalStagingLabelsToDownload: ['additionalStagingLabelsToDownload'],\n },\n};" }, "fqn": "@aws-cdk/aws-greengrass.CfnResourceDefinitionVersion.ResourceDataContainerProperty", "kind": "interface", "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 6651 }, "name": "ResourceDataContainerProperty", "namespace": "CfnResourceDefinitionVersion", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-resourcedatacontainer.html#cfn-greengrass-resourcedefinitionversion-resourcedatacontainer-localdeviceresourcedata" }, "stability": "external", "summary": "Settings for a local device resource." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 6657 }, "name": "localDeviceResourceData", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-greengrass.CfnResourceDefinitionVersion.LocalDeviceResourceDataProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-resourcedatacontainer.html#cfn-greengrass-resourcedefinitionversion-resourcedatacontainer-localvolumeresourcedata" }, "stability": "external", "summary": "Settings for a local volume resource." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 6663 }, "name": "localVolumeResourceData", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-greengrass.CfnResourceDefinitionVersion.LocalVolumeResourceDataProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-resourcedatacontainer.html#cfn-greengrass-resourcedefinitionversion-resourcedatacontainer-s3machinelearningmodelresourcedata" }, "stability": "external", "summary": "Settings for a machine learning resource stored in Amazon S3 ." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 6669 }, "name": "s3MachineLearningModelResourceData", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-greengrass.CfnResourceDefinitionVersion.S3MachineLearningModelResourceDataProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-resourcedatacontainer.html#cfn-greengrass-resourcedefinitionversion-resourcedatacontainer-sagemakermachinelearningmodelresourcedata" }, "stability": "external", "summary": "Settings for a machine learning resource saved as an SageMaker training job." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 6675 }, "name": "sageMakerMachineLearningModelResourceData", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-greengrass.CfnResourceDefinitionVersion.SageMakerMachineLearningModelResourceDataProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-resourcedatacontainer.html#cfn-greengrass-resourcedefinitionversion-resourcedatacontainer-secretsmanagersecretresourcedata" }, "stability": "external", "summary": "Settings for a secret resource." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 6681 }, "name": "secretsManagerSecretResourceData", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-greengrass.CfnResourceDefinitionVersion.SecretsManagerSecretResourceDataProperty" } ] } } } ], "symbolId": "lib/greengrass.generated:CfnResourceDefinitionVersion.ResourceDataContainerProperty" }, "@aws-cdk/aws-greengrass.CfnResourceDefinitionVersion.ResourceDownloadOwnerSettingProperty": { "assembly": "@aws-cdk/aws-greengrass", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-resourcedownloadownersetting.html", "exampleMetadata": "fixture=_generated" }, "remarks": "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* .\n\nIn 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.", "stability": "external", "summary": "The owner setting for a downloaded machine learning resource.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as greengrass from '@aws-cdk/aws-greengrass';\nconst resourceDownloadOwnerSettingProperty: greengrass.CfnResourceDefinitionVersion.ResourceDownloadOwnerSettingProperty = {\n groupOwner: 'groupOwner',\n groupPermission: 'groupPermission',\n};" }, "fqn": "@aws-cdk/aws-greengrass.CfnResourceDefinitionVersion.ResourceDownloadOwnerSettingProperty", "kind": "interface", "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 6756 }, "name": "ResourceDownloadOwnerSettingProperty", "namespace": "CfnResourceDefinitionVersion", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-resourcedownloadownersetting.html#cfn-greengrass-resourcedefinitionversion-resourcedownloadownersetting-groupowner" }, "remarks": "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.", "stability": "external", "summary": "The group owner of the machine learning resource." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 6762 }, "name": "groupOwner", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-resourcedownloadownersetting.html#cfn-greengrass-resourcedefinitionversion-resourcedownloadownersetting-grouppermission" }, "remarks": "Valid values are `rw` (read-write) or `ro` (read-only).", "stability": "external", "summary": "The permissions that the group owner has to the machine learning resource." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 6768 }, "name": "groupPermission", "type": { "primitive": "string" } } ], "symbolId": "lib/greengrass.generated:CfnResourceDefinitionVersion.ResourceDownloadOwnerSettingProperty" }, "@aws-cdk/aws-greengrass.CfnResourceDefinitionVersion.ResourceInstanceProperty": { "assembly": "@aws-cdk/aws-greengrass", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-resourceinstance.html", "exampleMetadata": "fixture=_generated" }, "remarks": "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* .\n\nIn 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.", "stability": "external", "summary": "A local resource, machine learning resource, or secret resource.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as greengrass from '@aws-cdk/aws-greengrass';\nconst resourceInstanceProperty: greengrass.CfnResourceDefinitionVersion.ResourceInstanceProperty = {\n id: 'id',\n name: 'name',\n resourceDataContainer: {\n localDeviceResourceData: {\n sourcePath: 'sourcePath',\n\n // the properties below are optional\n groupOwnerSetting: {\n autoAddGroupOwner: false,\n\n // the properties below are optional\n groupOwner: 'groupOwner',\n },\n },\n localVolumeResourceData: {\n destinationPath: 'destinationPath',\n sourcePath: 'sourcePath',\n\n // the properties below are optional\n groupOwnerSetting: {\n autoAddGroupOwner: false,\n\n // the properties below are optional\n groupOwner: 'groupOwner',\n },\n },\n s3MachineLearningModelResourceData: {\n destinationPath: 'destinationPath',\n s3Uri: 's3Uri',\n\n // the properties below are optional\n ownerSetting: {\n groupOwner: 'groupOwner',\n groupPermission: 'groupPermission',\n },\n },\n sageMakerMachineLearningModelResourceData: {\n destinationPath: 'destinationPath',\n sageMakerJobArn: 'sageMakerJobArn',\n\n // the properties below are optional\n ownerSetting: {\n groupOwner: 'groupOwner',\n groupPermission: 'groupPermission',\n },\n },\n secretsManagerSecretResourceData: {\n arn: 'arn',\n\n // the properties below are optional\n additionalStagingLabelsToDownload: ['additionalStagingLabelsToDownload'],\n },\n },\n};" }, "fqn": "@aws-cdk/aws-greengrass.CfnResourceDefinitionVersion.ResourceInstanceProperty", "kind": "interface", "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 6836 }, "name": "ResourceInstanceProperty", "namespace": "CfnResourceDefinitionVersion", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-resourceinstance.html#cfn-greengrass-resourcedefinitionversion-resourceinstance-id" }, "remarks": "This value must be unique within the resource definition version. Maximum length is 128 characters with pattern `[a-zA-Z0-9:_-]+` .", "stability": "external", "summary": "A descriptive or arbitrary ID for the resource." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 6842 }, "name": "id", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-resourceinstance.html#cfn-greengrass-resourcedefinitionversion-resourceinstance-name" }, "remarks": "Maximum length 128 characters with pattern [a-zA-Z0-9:_-]+. This must be unique within a Greengrass group.", "stability": "external", "summary": "The descriptive resource name, which is displayed on the AWS IoT Greengrass console." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 6848 }, "name": "name", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-resourceinstance.html#cfn-greengrass-resourcedefinitionversion-resourceinstance-resourcedatacontainer" }, "remarks": "The container takes only one of the following supported resource data types: `LocalDeviceResourceData` , `LocalVolumeResourceData` , `SageMakerMachineLearningModelResourceData` , `S3MachineLearningModelResourceData` , or `SecretsManagerSecretResourceData` .\n\n> Only one resource type can be defined for a `ResourceDataContainer` instance.", "stability": "external", "summary": "A container for resource data." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 6856 }, "name": "resourceDataContainer", "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-greengrass.CfnResourceDefinitionVersion.ResourceDataContainerProperty" } ] } } } ], "symbolId": "lib/greengrass.generated:CfnResourceDefinitionVersion.ResourceInstanceProperty" }, "@aws-cdk/aws-greengrass.CfnResourceDefinitionVersion.S3MachineLearningModelResourceDataProperty": { "assembly": "@aws-cdk/aws-greengrass", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-s3machinelearningmodelresourcedata.html", "exampleMetadata": "fixture=_generated" }, "remarks": "For more information, see [Perform Machine Learning Inference](https://docs.aws.amazon.com/greengrass/latest/developerguide/ml-inference.html) in the *Developer Guide* .\n\nIn 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.", "stability": "external", "summary": "Settings for an Amazon S3 machine learning resource.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as greengrass from '@aws-cdk/aws-greengrass';\nconst s3MachineLearningModelResourceDataProperty: greengrass.CfnResourceDefinitionVersion.S3MachineLearningModelResourceDataProperty = {\n destinationPath: 'destinationPath',\n s3Uri: 's3Uri',\n\n // the properties below are optional\n ownerSetting: {\n groupOwner: 'groupOwner',\n groupPermission: 'groupPermission',\n },\n};" }, "fqn": "@aws-cdk/aws-greengrass.CfnResourceDefinitionVersion.S3MachineLearningModelResourceDataProperty", "kind": "interface", "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 6928 }, "name": "S3MachineLearningModelResourceDataProperty", "namespace": "CfnResourceDefinitionVersion", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-s3machinelearningmodelresourcedata.html#cfn-greengrass-resourcedefinitionversion-s3machinelearningmodelresourcedata-destinationpath" }, "stability": "external", "summary": "The absolute local path of the resource inside the Lambda environment." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 6934 }, "name": "destinationPath", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-s3machinelearningmodelresourcedata.html#cfn-greengrass-resourcedefinitionversion-s3machinelearningmodelresourcedata-s3uri" }, "remarks": "The model package must be in `tar.gz` or `.zip` format.", "stability": "external", "summary": "The URI of the source model in an Amazon S3 bucket." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 6946 }, "name": "s3Uri", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-s3machinelearningmodelresourcedata.html#cfn-greengrass-resourcedefinitionversion-s3machinelearningmodelresourcedata-ownersetting" }, "remarks": "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* .", "stability": "external", "summary": "The owner setting for the downloaded machine learning resource." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 6940 }, "name": "ownerSetting", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-greengrass.CfnResourceDefinitionVersion.ResourceDownloadOwnerSettingProperty" } ] } } } ], "symbolId": "lib/greengrass.generated:CfnResourceDefinitionVersion.S3MachineLearningModelResourceDataProperty" }, "@aws-cdk/aws-greengrass.CfnResourceDefinitionVersion.SageMakerMachineLearningModelResourceDataProperty": { "assembly": "@aws-cdk/aws-greengrass", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-sagemakermachinelearningmodelresourcedata.html", "exampleMetadata": "fixture=_generated" }, "remarks": "For more information, see [Perform Machine Learning Inference](https://docs.aws.amazon.com/greengrass/latest/developerguide/ml-inference.html) in the *Developer Guide* .\n\nIn 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.", "stability": "external", "summary": "Settings for an Secrets Manager machine learning resource.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as greengrass from '@aws-cdk/aws-greengrass';\nconst sageMakerMachineLearningModelResourceDataProperty: greengrass.CfnResourceDefinitionVersion.SageMakerMachineLearningModelResourceDataProperty = {\n destinationPath: 'destinationPath',\n sageMakerJobArn: 'sageMakerJobArn',\n\n // the properties below are optional\n ownerSetting: {\n groupOwner: 'groupOwner',\n groupPermission: 'groupPermission',\n },\n};" }, "fqn": "@aws-cdk/aws-greengrass.CfnResourceDefinitionVersion.SageMakerMachineLearningModelResourceDataProperty", "kind": "interface", "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 7017 }, "name": "SageMakerMachineLearningModelResourceDataProperty", "namespace": "CfnResourceDefinitionVersion", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-sagemakermachinelearningmodelresourcedata.html#cfn-greengrass-resourcedefinitionversion-sagemakermachinelearningmodelresourcedata-destinationpath" }, "stability": "external", "summary": "The absolute local path of the resource inside the Lambda environment." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 7023 }, "name": "destinationPath", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-sagemakermachinelearningmodelresourcedata.html#cfn-greengrass-resourcedefinitionversion-sagemakermachinelearningmodelresourcedata-sagemakerjobarn" }, "stability": "external", "summary": "The Amazon Resource Name (ARN) of the Amazon SageMaker training job that represents the source model." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 7035 }, "name": "sageMakerJobArn", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-sagemakermachinelearningmodelresourcedata.html#cfn-greengrass-resourcedefinitionversion-sagemakermachinelearningmodelresourcedata-ownersetting" }, "remarks": "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* .", "stability": "external", "summary": "The owner setting for the downloaded machine learning resource." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 7029 }, "name": "ownerSetting", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-greengrass.CfnResourceDefinitionVersion.ResourceDownloadOwnerSettingProperty" } ] } } } ], "symbolId": "lib/greengrass.generated:CfnResourceDefinitionVersion.SageMakerMachineLearningModelResourceDataProperty" }, "@aws-cdk/aws-greengrass.CfnResourceDefinitionVersion.SecretsManagerSecretResourceDataProperty": { "assembly": "@aws-cdk/aws-greengrass", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-secretsmanagersecretresourcedata.html", "exampleMetadata": "fixture=_generated" }, "remarks": "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* .\n\nIn 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.", "stability": "external", "summary": "Settings for a secret resource, which references a secret from AWS Secrets Manager .", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as greengrass from '@aws-cdk/aws-greengrass';\nconst secretsManagerSecretResourceDataProperty: greengrass.CfnResourceDefinitionVersion.SecretsManagerSecretResourceDataProperty = {\n arn: 'arn',\n\n // the properties below are optional\n additionalStagingLabelsToDownload: ['additionalStagingLabelsToDownload'],\n};" }, "fqn": "@aws-cdk/aws-greengrass.CfnResourceDefinitionVersion.SecretsManagerSecretResourceDataProperty", "kind": "interface", "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 7106 }, "name": "SecretsManagerSecretResourceDataProperty", "namespace": "CfnResourceDefinitionVersion", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-secretsmanagersecretresourcedata.html#cfn-greengrass-resourcedefinitionversion-secretsmanagersecretresourcedata-arn" }, "remarks": "The value of the secret's latest version (represented by the `AWSCURRENT` staging label) is included by default.", "stability": "external", "summary": "The Amazon Resource Name (ARN) of the Secrets Manager secret to make available on the core." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 7112 }, "name": "arn", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-secretsmanagersecretresourcedata.html#cfn-greengrass-resourcedefinitionversion-secretsmanagersecretresourcedata-additionalstaginglabelstodownload" }, "stability": "external", "summary": "The staging labels whose values you want to make available on the core, in addition to `AWSCURRENT` ." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 7118 }, "name": "additionalStagingLabelsToDownload", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } ], "symbolId": "lib/greengrass.generated:CfnResourceDefinitionVersion.SecretsManagerSecretResourceDataProperty" }, "@aws-cdk/aws-greengrass.CfnResourceDefinitionVersionProps": { "assembly": "@aws-cdk/aws-greengrass", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-resourcedefinitionversion.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Properties for defining a `CfnResourceDefinitionVersion`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as greengrass from '@aws-cdk/aws-greengrass';\nconst cfnResourceDefinitionVersionProps: greengrass.CfnResourceDefinitionVersionProps = {\n resourceDefinitionId: 'resourceDefinitionId',\n resources: [{\n id: 'id',\n name: 'name',\n resourceDataContainer: {\n localDeviceResourceData: {\n sourcePath: 'sourcePath',\n\n // the properties below are optional\n groupOwnerSetting: {\n autoAddGroupOwner: false,\n\n // the properties below are optional\n groupOwner: 'groupOwner',\n },\n },\n localVolumeResourceData: {\n destinationPath: 'destinationPath',\n sourcePath: 'sourcePath',\n\n // the properties below are optional\n groupOwnerSetting: {\n autoAddGroupOwner: false,\n\n // the properties below are optional\n groupOwner: 'groupOwner',\n },\n },\n s3MachineLearningModelResourceData: {\n destinationPath: 'destinationPath',\n s3Uri: 's3Uri',\n\n // the properties below are optional\n ownerSetting: {\n groupOwner: 'groupOwner',\n groupPermission: 'groupPermission',\n },\n },\n sageMakerMachineLearningModelResourceData: {\n destinationPath: 'destinationPath',\n sageMakerJobArn: 'sageMakerJobArn',\n\n // the properties below are optional\n ownerSetting: {\n groupOwner: 'groupOwner',\n groupPermission: 'groupPermission',\n },\n },\n secretsManagerSecretResourceData: {\n arn: 'arn',\n\n // the properties below are optional\n additionalStagingLabelsToDownload: ['additionalStagingLabelsToDownload'],\n },\n },\n }],\n};" }, "fqn": "@aws-cdk/aws-greengrass.CfnResourceDefinitionVersionProps", "kind": "interface", "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 6232 }, "name": "CfnResourceDefinitionVersionProps", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-resourcedefinitionversion.html#cfn-greengrass-resourcedefinitionversion-resourcedefinitionid" }, "remarks": "This value is a GUID.", "stability": "external", "summary": "The ID of the resource definition associated with this version." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 6239 }, "name": "resourceDefinitionId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-resourcedefinitionversion.html#cfn-greengrass-resourcedefinitionversion-resources" }, "stability": "external", "summary": "The resources in this version." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 6246 }, "name": "resources", "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-greengrass.CfnResourceDefinitionVersion.ResourceInstanceProperty" } ] } }, "kind": "array" } } ] } } } ], "symbolId": "lib/greengrass.generated:CfnResourceDefinitionVersionProps" }, "@aws-cdk/aws-greengrass.CfnSubscriptionDefinition": { "assembly": "@aws-cdk/aws-greengrass", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::Greengrass::SubscriptionDefinition", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-subscriptiondefinition.html", "exampleMetadata": "fixture=_generated" }, "remarks": "The `AWS::Greengrass::SubscriptionDefinition` resource represents a subscription definition for AWS IoT Greengrass . Subscription definitions are used to organize your subscription definition versions.\n\nSubscription 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.\n\n> 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.\n>\n> 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) .", "stability": "external", "summary": "A CloudFormation `AWS::Greengrass::SubscriptionDefinition`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as greengrass from '@aws-cdk/aws-greengrass';\n\ndeclare const tags: any;\nconst cfnSubscriptionDefinition = new greengrass.CfnSubscriptionDefinition(this, 'MyCfnSubscriptionDefinition', {\n name: 'name',\n\n // the properties below are optional\n initialVersion: {\n subscriptions: [{\n id: 'id',\n source: 'source',\n subject: 'subject',\n target: 'target',\n }],\n },\n tags: tags,\n});" }, "fqn": "@aws-cdk/aws-greengrass.CfnSubscriptionDefinition", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::Greengrass::SubscriptionDefinition`." }, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 7369 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "@aws-cdk/aws-greengrass.CfnSubscriptionDefinitionProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 7283 }, "methods": [ { "docs": { "stability": "external", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 7388 }, "name": "inspect", "overrides": "@aws-cdk/core.IInspectable", "parameters": [ { "docs": { "summary": "- tree inspector to collect and process attributes." }, "name": "inspector", "type": { "fqn": "@aws-cdk/core.TreeInspector" } } ] }, { "docs": { "stability": "external" }, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 7401 }, "name": "renderProperties", "overrides": "@aws-cdk/core.CfnResource", "parameters": [ { "name": "props", "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } ], "protected": true, "returns": { "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } } ], "name": "CfnSubscriptionDefinition", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 7287 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "Arn" }, "stability": "external", "summary": "The Amazon Resource Name (ARN) of the `SubscriptionDefinition` , such as `arn:aws:greengrass:us-east-1: :/greengrass/definition/subscriptions/1234a5b6-78cd-901e-2fgh-3i45j6k178l9` ." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 7312 }, "name": "attrArn", "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "Id" }, "stability": "external", "summary": "The ID of the `SubscriptionDefinition` , such as `1234a5b6-78cd-901e-2fgh-3i45j6k178l9` ." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 7318 }, "name": "attrId", "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "LatestVersionArn" }, "stability": "external", "summary": "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` ." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 7324 }, "name": "attrLatestVersionArn", "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "Name" }, "stability": "external", "summary": "The name of the `SubscriptionDefinition` , such as `MySubscriptionDefinition` ." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 7330 }, "name": "attrName", "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 7393 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-subscriptiondefinition.html#cfn-greengrass-subscriptiondefinition-tags" }, "remarks": "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* .\n\nThis `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.\n\n```json\n\"Tags\": { \"KeyName0\": \"value\", \"KeyName1\": \"value\", \"KeyName2\": \"value\"\n}\n```", "stability": "external", "summary": "Application-specific metadata to attach to the subscription definition." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 7360 }, "name": "tags", "type": { "fqn": "@aws-cdk/core.TagManager" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-subscriptiondefinition.html#cfn-greengrass-subscriptiondefinition-name" }, "stability": "external", "summary": "The name of the subscription definition." }, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 7337 }, "name": "name", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-subscriptiondefinition.html#cfn-greengrass-subscriptiondefinition-initialversion" }, "remarks": "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.\n\n> 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.", "stability": "external", "summary": "The subscription definition version to include when the subscription definition is created." }, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 7346 }, "name": "initialVersion", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-greengrass.CfnSubscriptionDefinition.SubscriptionDefinitionVersionProperty" } ] } } } ], "symbolId": "lib/greengrass.generated:CfnSubscriptionDefinition" }, "@aws-cdk/aws-greengrass.CfnSubscriptionDefinition.SubscriptionDefinitionVersionProperty": { "assembly": "@aws-cdk/aws-greengrass", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-subscriptiondefinition-subscriptiondefinitionversion.html", "exampleMetadata": "fixture=_generated" }, "remarks": "> 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) .\n\nIn 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.", "stability": "external", "summary": "A subscription definition version contains a list of [subscriptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-subscriptiondefinition-subscription.html) .", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as greengrass from '@aws-cdk/aws-greengrass';\nconst subscriptionDefinitionVersionProperty: greengrass.CfnSubscriptionDefinition.SubscriptionDefinitionVersionProperty = {\n subscriptions: [{\n id: 'id',\n source: 'source',\n subject: 'subject',\n target: 'target',\n }],\n};" }, "fqn": "@aws-cdk/aws-greengrass.CfnSubscriptionDefinition.SubscriptionDefinitionVersionProperty", "kind": "interface", "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 7519 }, "name": "SubscriptionDefinitionVersionProperty", "namespace": "CfnSubscriptionDefinition", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-subscriptiondefinition-subscriptiondefinitionversion.html#cfn-greengrass-subscriptiondefinition-subscriptiondefinitionversion-subscriptions" }, "stability": "external", "summary": "The subscriptions in this version." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 7525 }, "name": "subscriptions", "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-greengrass.CfnSubscriptionDefinition.SubscriptionProperty" } ] } }, "kind": "array" } } ] } } } ], "symbolId": "lib/greengrass.generated:CfnSubscriptionDefinition.SubscriptionDefinitionVersionProperty" }, "@aws-cdk/aws-greengrass.CfnSubscriptionDefinition.SubscriptionProperty": { "assembly": "@aws-cdk/aws-greengrass", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-subscriptiondefinition-subscription.html", "exampleMetadata": "fixture=_generated" }, "remarks": "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.\n\nIn 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.", "stability": "external", "summary": "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.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as greengrass from '@aws-cdk/aws-greengrass';\nconst subscriptionProperty: greengrass.CfnSubscriptionDefinition.SubscriptionProperty = {\n id: 'id',\n source: 'source',\n subject: 'subject',\n target: 'target',\n};" }, "fqn": "@aws-cdk/aws-greengrass.CfnSubscriptionDefinition.SubscriptionProperty", "kind": "interface", "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 7417 }, "name": "SubscriptionProperty", "namespace": "CfnSubscriptionDefinition", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-subscriptiondefinition-subscription.html#cfn-greengrass-subscriptiondefinition-subscription-id" }, "remarks": "This value must be unique within the subscription definition version. Maximum length is 128 characters with pattern `[a-zA-Z0-9:_-]+` .", "stability": "external", "summary": "A descriptive or arbitrary ID for the subscription." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 7423 }, "name": "id", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-subscriptiondefinition-subscription.html#cfn-greengrass-subscriptiondefinition-subscription-source" }, "remarks": "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` .", "stability": "external", "summary": "The originator of the message." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 7429 }, "name": "source", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-subscriptiondefinition-subscription.html#cfn-greengrass-subscriptiondefinition-subscription-subject" }, "stability": "external", "summary": "The MQTT topic used to route the message." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 7435 }, "name": "subject", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-subscriptiondefinition-subscription.html#cfn-greengrass-subscriptiondefinition-subscription-target" }, "remarks": "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` .", "stability": "external", "summary": "The destination of the message." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 7441 }, "name": "target", "type": { "primitive": "string" } } ], "symbolId": "lib/greengrass.generated:CfnSubscriptionDefinition.SubscriptionProperty" }, "@aws-cdk/aws-greengrass.CfnSubscriptionDefinitionProps": { "assembly": "@aws-cdk/aws-greengrass", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-subscriptiondefinition.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Properties for defining a `CfnSubscriptionDefinition`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as greengrass from '@aws-cdk/aws-greengrass';\n\ndeclare const tags: any;\nconst cfnSubscriptionDefinitionProps: greengrass.CfnSubscriptionDefinitionProps = {\n name: 'name',\n\n // the properties below are optional\n initialVersion: {\n subscriptions: [{\n id: 'id',\n source: 'source',\n subject: 'subject',\n target: 'target',\n }],\n },\n tags: tags,\n};" }, "fqn": "@aws-cdk/aws-greengrass.CfnSubscriptionDefinitionProps", "kind": "interface", "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 7182 }, "name": "CfnSubscriptionDefinitionProps", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-subscriptiondefinition.html#cfn-greengrass-subscriptiondefinition-name" }, "stability": "external", "summary": "The name of the subscription definition." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 7189 }, "name": "name", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-subscriptiondefinition.html#cfn-greengrass-subscriptiondefinition-initialversion" }, "remarks": "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.\n\n> 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.", "stability": "external", "summary": "The subscription definition version to include when the subscription definition is created." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 7198 }, "name": "initialVersion", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-greengrass.CfnSubscriptionDefinition.SubscriptionDefinitionVersionProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-subscriptiondefinition.html#cfn-greengrass-subscriptiondefinition-tags" }, "remarks": "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* .\n\nThis `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.\n\n```json\n\"Tags\": { \"KeyName0\": \"value\", \"KeyName1\": \"value\", \"KeyName2\": \"value\"\n}\n```", "stability": "external", "summary": "Application-specific metadata to attach to the subscription definition." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 7212 }, "name": "tags", "optional": true, "type": { "primitive": "any" } } ], "symbolId": "lib/greengrass.generated:CfnSubscriptionDefinitionProps" }, "@aws-cdk/aws-greengrass.CfnSubscriptionDefinitionVersion": { "assembly": "@aws-cdk/aws-greengrass", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::Greengrass::SubscriptionDefinitionVersion", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-subscriptiondefinitionversion.html", "exampleMetadata": "fixture=_generated" }, "remarks": "The `AWS::Greengrass::SubscriptionDefinitionVersion` resource represents a subscription definition version for AWS IoT Greengrass . A subscription definition version contains a list of subscriptions.\n\n> 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) .\n>\n> 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) .", "stability": "external", "summary": "A CloudFormation `AWS::Greengrass::SubscriptionDefinitionVersion`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as greengrass from '@aws-cdk/aws-greengrass';\nconst cfnSubscriptionDefinitionVersion = new greengrass.CfnSubscriptionDefinitionVersion(this, 'MyCfnSubscriptionDefinitionVersion', {\n subscriptionDefinitionId: 'subscriptionDefinitionId',\n subscriptions: [{\n id: 'id',\n source: 'source',\n subject: 'subject',\n target: 'target',\n }],\n});" }, "fqn": "@aws-cdk/aws-greengrass.CfnSubscriptionDefinitionVersion", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::Greengrass::SubscriptionDefinitionVersion`." }, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 7713 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "@aws-cdk/aws-greengrass.CfnSubscriptionDefinitionVersionProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 7667 }, "methods": [ { "docs": { "stability": "external", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 7728 }, "name": "inspect", "overrides": "@aws-cdk/core.IInspectable", "parameters": [ { "docs": { "summary": "- tree inspector to collect and process attributes." }, "name": "inspector", "type": { "fqn": "@aws-cdk/core.TreeInspector" } } ] }, { "docs": { "stability": "external" }, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 7740 }, "name": "renderProperties", "overrides": "@aws-cdk/core.CfnResource", "parameters": [ { "name": "props", "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } ], "protected": true, "returns": { "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } } ], "name": "CfnSubscriptionDefinitionVersion", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 7671 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 7733 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-subscriptiondefinitionversion.html#cfn-greengrass-subscriptiondefinitionversion-subscriptiondefinitionid" }, "remarks": "This value is a GUID.", "stability": "external", "summary": "The ID of the subscription definition associated with this version." }, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 7697 }, "name": "subscriptionDefinitionId", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-subscriptiondefinitionversion.html#cfn-greengrass-subscriptiondefinitionversion-subscriptions" }, "stability": "external", "summary": "The subscriptions in this version." }, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 7704 }, "name": "subscriptions", "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-greengrass.CfnSubscriptionDefinitionVersion.SubscriptionProperty" } ] } }, "kind": "array" } } ] } } } ], "symbolId": "lib/greengrass.generated:CfnSubscriptionDefinitionVersion" }, "@aws-cdk/aws-greengrass.CfnSubscriptionDefinitionVersion.SubscriptionProperty": { "assembly": "@aws-cdk/aws-greengrass", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-subscriptiondefinitionversion-subscription.html", "exampleMetadata": "fixture=_generated" }, "remarks": "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.\n\nIn 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.", "stability": "external", "summary": "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.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as greengrass from '@aws-cdk/aws-greengrass';\nconst subscriptionProperty: greengrass.CfnSubscriptionDefinitionVersion.SubscriptionProperty = {\n id: 'id',\n source: 'source',\n subject: 'subject',\n target: 'target',\n};" }, "fqn": "@aws-cdk/aws-greengrass.CfnSubscriptionDefinitionVersion.SubscriptionProperty", "kind": "interface", "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 7756 }, "name": "SubscriptionProperty", "namespace": "CfnSubscriptionDefinitionVersion", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-subscriptiondefinitionversion-subscription.html#cfn-greengrass-subscriptiondefinitionversion-subscription-id" }, "remarks": "This value must be unique within the subscription definition version. Maximum length is 128 characters with pattern `[a-zA-Z0-9:_-]+` .", "stability": "external", "summary": "A descriptive or arbitrary ID for the subscription." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 7762 }, "name": "id", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-subscriptiondefinitionversion-subscription.html#cfn-greengrass-subscriptiondefinitionversion-subscription-source" }, "remarks": "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` .", "stability": "external", "summary": "The originator of the message." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 7768 }, "name": "source", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-subscriptiondefinitionversion-subscription.html#cfn-greengrass-subscriptiondefinitionversion-subscription-subject" }, "stability": "external", "summary": "The MQTT topic used to route the message." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 7774 }, "name": "subject", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-subscriptiondefinitionversion-subscription.html#cfn-greengrass-subscriptiondefinitionversion-subscription-target" }, "remarks": "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` .", "stability": "external", "summary": "The destination of the message." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 7780 }, "name": "target", "type": { "primitive": "string" } } ], "symbolId": "lib/greengrass.generated:CfnSubscriptionDefinitionVersion.SubscriptionProperty" }, "@aws-cdk/aws-greengrass.CfnSubscriptionDefinitionVersionProps": { "assembly": "@aws-cdk/aws-greengrass", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-subscriptiondefinitionversion.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Properties for defining a `CfnSubscriptionDefinitionVersion`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as greengrass from '@aws-cdk/aws-greengrass';\nconst cfnSubscriptionDefinitionVersionProps: greengrass.CfnSubscriptionDefinitionVersionProps = {\n subscriptionDefinitionId: 'subscriptionDefinitionId',\n subscriptions: [{\n id: 'id',\n source: 'source',\n subject: 'subject',\n target: 'target',\n }],\n};" }, "fqn": "@aws-cdk/aws-greengrass.CfnSubscriptionDefinitionVersionProps", "kind": "interface", "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 7586 }, "name": "CfnSubscriptionDefinitionVersionProps", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-subscriptiondefinitionversion.html#cfn-greengrass-subscriptiondefinitionversion-subscriptiondefinitionid" }, "remarks": "This value is a GUID.", "stability": "external", "summary": "The ID of the subscription definition associated with this version." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 7593 }, "name": "subscriptionDefinitionId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-subscriptiondefinitionversion.html#cfn-greengrass-subscriptiondefinitionversion-subscriptions" }, "stability": "external", "summary": "The subscriptions in this version." }, "immutable": true, "locationInModule": { "filename": "lib/greengrass.generated.ts", "line": 7600 }, "name": "subscriptions", "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-greengrass.CfnSubscriptionDefinitionVersion.SubscriptionProperty" } ] } }, "kind": "array" } } ] } } } ], "symbolId": "lib/greengrass.generated:CfnSubscriptionDefinitionVersionProps" } }, "version": "1.204.0", "fingerprint": "**********" }