Documentation ¶
Index ¶
- func CfnComponentVersion_CFN_RESOURCE_TYPE_NAME() *string
- func CfnComponentVersion_IsCfnElement(x interface{}) *bool
- func CfnComponentVersion_IsCfnResource(x interface{}) *bool
- func CfnComponentVersion_IsConstruct(x interface{}) *bool
- func CfnDeployment_CFN_RESOURCE_TYPE_NAME() *string
- func CfnDeployment_IsCfnElement(x interface{}) *bool
- func CfnDeployment_IsCfnResource(x interface{}) *bool
- func CfnDeployment_IsConstruct(x interface{}) *bool
- func NewCfnComponentVersion_Override(c CfnComponentVersion, scope constructs.Construct, id *string, ...)
- func NewCfnDeployment_Override(c CfnDeployment, scope constructs.Construct, id *string, ...)
- type CfnComponentVersion
- type CfnComponentVersionProps
- type CfnComponentVersion_ComponentDependencyRequirementProperty
- type CfnComponentVersion_ComponentPlatformProperty
- type CfnComponentVersion_LambdaContainerParamsProperty
- type CfnComponentVersion_LambdaDeviceMountProperty
- type CfnComponentVersion_LambdaEventSourceProperty
- type CfnComponentVersion_LambdaExecutionParametersProperty
- type CfnComponentVersion_LambdaFunctionRecipeSourceProperty
- type CfnComponentVersion_LambdaLinuxProcessParamsProperty
- type CfnComponentVersion_LambdaVolumeMountProperty
- type CfnDeployment
- type CfnDeploymentProps
- type CfnDeployment_ComponentConfigurationUpdateProperty
- type CfnDeployment_ComponentDeploymentSpecificationProperty
- type CfnDeployment_ComponentRunWithProperty
- type CfnDeployment_DeploymentComponentUpdatePolicyProperty
- type CfnDeployment_DeploymentConfigurationValidationPolicyProperty
- type CfnDeployment_DeploymentIoTJobConfigurationProperty
- type CfnDeployment_DeploymentPoliciesProperty
- type CfnDeployment_IoTJobAbortConfigProperty
- type CfnDeployment_IoTJobAbortCriteriaProperty
- type CfnDeployment_IoTJobExecutionsRolloutConfigProperty
- type CfnDeployment_IoTJobExponentialRolloutRateProperty
- type CfnDeployment_IoTJobTimeoutConfigProperty
- type CfnDeployment_SystemResourceLimitsProperty
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CfnComponentVersion_CFN_RESOURCE_TYPE_NAME ¶
func CfnComponentVersion_CFN_RESOURCE_TYPE_NAME() *string
func CfnComponentVersion_IsCfnElement ¶
func CfnComponentVersion_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnComponentVersion_IsCfnResource ¶
func CfnComponentVersion_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnComponentVersion_IsConstruct ¶
func CfnComponentVersion_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnDeployment_CFN_RESOURCE_TYPE_NAME ¶ added in v2.46.0
func CfnDeployment_CFN_RESOURCE_TYPE_NAME() *string
func CfnDeployment_IsCfnElement ¶ added in v2.46.0
func CfnDeployment_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnDeployment_IsCfnResource ¶ added in v2.46.0
func CfnDeployment_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnDeployment_IsConstruct ¶ added in v2.46.0
func CfnDeployment_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func NewCfnComponentVersion_Override ¶
func NewCfnComponentVersion_Override(c CfnComponentVersion, scope constructs.Construct, id *string, props *CfnComponentVersionProps)
func NewCfnDeployment_Override ¶ added in v2.46.0
func NewCfnDeployment_Override(c CfnDeployment, scope constructs.Construct, id *string, props *CfnDeploymentProps)
Types ¶
type CfnComponentVersion ¶
type CfnComponentVersion interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable // The ARN of the component version. AttrArn() *string // The name of the component. AttrComponentName() *string // The version of the component. AttrComponentVersion() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The recipe to use to create the component. InlineRecipe() *string SetInlineRecipe(val *string) // The parameters to create a component from a Lambda function. LambdaFunction() interface{} SetLambdaFunction(val interface{}) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // Application-specific metadata to attach to the component version. TagsRaw() *map[string]*string SetTagsRaw(val *map[string]*string) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
Creates a component.
Components are software that run on AWS IoT Greengrass core devices. After you develop and test a component on your core device, you can use this operation to upload your component to AWS IoT Greengrass . Then, you can deploy the component to other core devices.
You can use this operation to do the following:
- *Create components from recipes*
Create a component from a recipe, which is a file that defines the component's metadata, parameters, dependencies, lifecycle, artifacts, and platform capability. For more information, see [AWS IoT Greengrass component recipe reference](https://docs.aws.amazon.com/greengrass/v2/developerguide/component-recipe-reference.html) in the *AWS IoT Greengrass V2 Developer Guide* .
To create a component from a recipe, specify `inlineRecipe` when you call this operation. - *Create components from Lambda functions*
Create a component from an AWS Lambda function that runs on AWS IoT Greengrass . This creates a recipe and artifacts from the Lambda function's deployment package. You can use this operation to migrate Lambda functions from AWS IoT Greengrass V1 to AWS IoT Greengrass V2 .
This function accepts Lambda functions in all supported versions of Python, Node.js, and Java runtimes. AWS IoT Greengrass doesn't apply any additional restrictions on deprecated Lambda runtime versions.
To create a component from a Lambda function, specify `lambdaFunction` when you call this operation.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnComponentVersion := awscdk.Aws_greengrassv2.NewCfnComponentVersion(this, jsii.String("MyCfnComponentVersion"), &CfnComponentVersionProps{ InlineRecipe: jsii.String("inlineRecipe"), LambdaFunction: &LambdaFunctionRecipeSourceProperty{ ComponentDependencies: map[string]interface{}{ "componentDependenciesKey": &ComponentDependencyRequirementProperty{ "dependencyType": jsii.String("dependencyType"), "versionRequirement": jsii.String("versionRequirement"), }, }, ComponentLambdaParameters: &LambdaExecutionParametersProperty{ EnvironmentVariables: map[string]*string{ "environmentVariablesKey": jsii.String("environmentVariables"), }, EventSources: []interface{}{ &LambdaEventSourceProperty{ Topic: jsii.String("topic"), Type: jsii.String("type"), }, }, ExecArgs: []*string{ jsii.String("execArgs"), }, InputPayloadEncodingType: jsii.String("inputPayloadEncodingType"), LinuxProcessParams: &LambdaLinuxProcessParamsProperty{ ContainerParams: &LambdaContainerParamsProperty{ Devices: []interface{}{ &LambdaDeviceMountProperty{ AddGroupOwner: jsii.Boolean(false), Path: jsii.String("path"), Permission: jsii.String("permission"), }, }, MemorySizeInKb: jsii.Number(123), MountRoSysfs: jsii.Boolean(false), Volumes: []interface{}{ &LambdaVolumeMountProperty{ AddGroupOwner: jsii.Boolean(false), DestinationPath: jsii.String("destinationPath"), Permission: jsii.String("permission"), SourcePath: jsii.String("sourcePath"), }, }, }, IsolationMode: jsii.String("isolationMode"), }, MaxIdleTimeInSeconds: jsii.Number(123), MaxInstancesCount: jsii.Number(123), MaxQueueSize: jsii.Number(123), Pinned: jsii.Boolean(false), StatusTimeoutInSeconds: jsii.Number(123), TimeoutInSeconds: jsii.Number(123), }, ComponentName: jsii.String("componentName"), ComponentPlatforms: []interface{}{ &ComponentPlatformProperty{ Attributes: map[string]*string{ "attributesKey": jsii.String("attributes"), }, Name: jsii.String("name"), }, }, ComponentVersion: jsii.String("componentVersion"), LambdaArn: jsii.String("lambdaArn"), }, Tags: map[string]*string{ "tagsKey": jsii.String("tags"), }, })
func NewCfnComponentVersion ¶
func NewCfnComponentVersion(scope constructs.Construct, id *string, props *CfnComponentVersionProps) CfnComponentVersion
type CfnComponentVersionProps ¶
type CfnComponentVersionProps struct { // The recipe to use to create the component. // // The recipe defines the component's metadata, parameters, dependencies, lifecycle, artifacts, and platform compatibility. // // You must specify either `InlineRecipe` or `LambdaFunction` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrassv2-componentversion.html#cfn-greengrassv2-componentversion-inlinerecipe // InlineRecipe *string `field:"optional" json:"inlineRecipe" yaml:"inlineRecipe"` // The parameters to create a component from a Lambda function. // // You must specify either `InlineRecipe` or `LambdaFunction` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrassv2-componentversion.html#cfn-greengrassv2-componentversion-lambdafunction // LambdaFunction interface{} `field:"optional" json:"lambdaFunction" yaml:"lambdaFunction"` // Application-specific metadata to attach to the component version. // // 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 [Tag your AWS IoT Greengrass Version 2 resources](https://docs.aws.amazon.com/greengrass/v2/developerguide/tag-resources.html) in the *AWS IoT Greengrass V2 Developer Guide* . // // This `Json` property type is processed as a map of key-value pairs. It uses the following format, which is different from most `Tags` implementations in AWS CloudFormation templates. // // “`json // "Tags": { "KeyName0": "value", "KeyName1": "value", "KeyName2": "value" // } // “`. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrassv2-componentversion.html#cfn-greengrassv2-componentversion-tags // Tags *map[string]*string `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnComponentVersion`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnComponentVersionProps := &CfnComponentVersionProps{ InlineRecipe: jsii.String("inlineRecipe"), LambdaFunction: &LambdaFunctionRecipeSourceProperty{ ComponentDependencies: map[string]interface{}{ "componentDependenciesKey": &ComponentDependencyRequirementProperty{ "dependencyType": jsii.String("dependencyType"), "versionRequirement": jsii.String("versionRequirement"), }, }, ComponentLambdaParameters: &LambdaExecutionParametersProperty{ EnvironmentVariables: map[string]*string{ "environmentVariablesKey": jsii.String("environmentVariables"), }, EventSources: []interface{}{ &LambdaEventSourceProperty{ Topic: jsii.String("topic"), Type: jsii.String("type"), }, }, ExecArgs: []*string{ jsii.String("execArgs"), }, InputPayloadEncodingType: jsii.String("inputPayloadEncodingType"), LinuxProcessParams: &LambdaLinuxProcessParamsProperty{ ContainerParams: &LambdaContainerParamsProperty{ Devices: []interface{}{ &LambdaDeviceMountProperty{ AddGroupOwner: jsii.Boolean(false), Path: jsii.String("path"), Permission: jsii.String("permission"), }, }, MemorySizeInKb: jsii.Number(123), MountRoSysfs: jsii.Boolean(false), Volumes: []interface{}{ &LambdaVolumeMountProperty{ AddGroupOwner: jsii.Boolean(false), DestinationPath: jsii.String("destinationPath"), Permission: jsii.String("permission"), SourcePath: jsii.String("sourcePath"), }, }, }, IsolationMode: jsii.String("isolationMode"), }, MaxIdleTimeInSeconds: jsii.Number(123), MaxInstancesCount: jsii.Number(123), MaxQueueSize: jsii.Number(123), Pinned: jsii.Boolean(false), StatusTimeoutInSeconds: jsii.Number(123), TimeoutInSeconds: jsii.Number(123), }, ComponentName: jsii.String("componentName"), ComponentPlatforms: []interface{}{ &ComponentPlatformProperty{ Attributes: map[string]*string{ "attributesKey": jsii.String("attributes"), }, Name: jsii.String("name"), }, }, ComponentVersion: jsii.String("componentVersion"), LambdaArn: jsii.String("lambdaArn"), }, Tags: map[string]*string{ "tagsKey": jsii.String("tags"), }, }
type CfnComponentVersion_ComponentDependencyRequirementProperty ¶
type CfnComponentVersion_ComponentDependencyRequirementProperty struct { // The type of this dependency. Choose from the following options:. // // - `SOFT` – The component doesn't restart if the dependency changes state. // - `HARD` – The component restarts if the dependency changes state. // // Default: `HARD`. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-componentversion-componentdependencyrequirement.html#cfn-greengrassv2-componentversion-componentdependencyrequirement-dependencytype // DependencyType *string `field:"optional" json:"dependencyType" yaml:"dependencyType"` // The component version requirement for the component dependency. // // AWS IoT Greengrass uses semantic version constraints. For more information, see [Semantic Versioning](https://docs.aws.amazon.com/https://semver.org/) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-componentversion-componentdependencyrequirement.html#cfn-greengrassv2-componentversion-componentdependencyrequirement-versionrequirement // VersionRequirement *string `field:"optional" json:"versionRequirement" yaml:"versionRequirement"` }
Contains information about a component dependency for a Lambda function component.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" componentDependencyRequirementProperty := &ComponentDependencyRequirementProperty{ DependencyType: jsii.String("dependencyType"), VersionRequirement: jsii.String("versionRequirement"), }
type CfnComponentVersion_ComponentPlatformProperty ¶
type CfnComponentVersion_ComponentPlatformProperty struct { // A dictionary of attributes for the platform. // // The AWS IoT Greengrass Core software defines the `os` and `platform` by default. You can specify additional platform attributes for a core device when you deploy the AWS IoT Greengrass nucleus component. For more information, see the [AWS IoT Greengrass nucleus component](https://docs.aws.amazon.com/greengrass/v2/developerguide/greengrass-nucleus-component.html) in the *AWS IoT Greengrass V2 Developer Guide* . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-componentversion-componentplatform.html#cfn-greengrassv2-componentversion-componentplatform-attributes // Attributes interface{} `field:"optional" json:"attributes" yaml:"attributes"` // The friendly name of the platform. This name helps you identify the platform. // // If you omit this parameter, AWS IoT Greengrass creates a friendly name from the `os` and `architecture` of the platform. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-componentversion-componentplatform.html#cfn-greengrassv2-componentversion-componentplatform-name // Name *string `field:"optional" json:"name" yaml:"name"` }
Contains information about a platform that a component supports.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" componentPlatformProperty := &ComponentPlatformProperty{ Attributes: map[string]*string{ "attributesKey": jsii.String("attributes"), }, Name: jsii.String("name"), }
type CfnComponentVersion_LambdaContainerParamsProperty ¶
type CfnComponentVersion_LambdaContainerParamsProperty struct { // The list of system devices that the container can access. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-componentversion-lambdacontainerparams.html#cfn-greengrassv2-componentversion-lambdacontainerparams-devices // Devices interface{} `field:"optional" json:"devices" yaml:"devices"` // The memory size of the container, expressed in kilobytes. // // Default: `16384` (16 MB). // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-componentversion-lambdacontainerparams.html#cfn-greengrassv2-componentversion-lambdacontainerparams-memorysizeinkb // MemorySizeInKb *float64 `field:"optional" json:"memorySizeInKb" yaml:"memorySizeInKb"` // Whether or not the container can read information from the device's `/sys` folder. // // Default: `false`. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-componentversion-lambdacontainerparams.html#cfn-greengrassv2-componentversion-lambdacontainerparams-mountrosysfs // MountRoSysfs interface{} `field:"optional" json:"mountRoSysfs" yaml:"mountRoSysfs"` // The list of volumes that the container can access. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-componentversion-lambdacontainerparams.html#cfn-greengrassv2-componentversion-lambdacontainerparams-volumes // Volumes interface{} `field:"optional" json:"volumes" yaml:"volumes"` }
Contains information about a container in which AWS Lambda functions run on AWS IoT Greengrass core devices.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" lambdaContainerParamsProperty := &LambdaContainerParamsProperty{ Devices: []interface{}{ &LambdaDeviceMountProperty{ AddGroupOwner: jsii.Boolean(false), Path: jsii.String("path"), Permission: jsii.String("permission"), }, }, MemorySizeInKb: jsii.Number(123), MountRoSysfs: jsii.Boolean(false), Volumes: []interface{}{ &LambdaVolumeMountProperty{ AddGroupOwner: jsii.Boolean(false), DestinationPath: jsii.String("destinationPath"), Permission: jsii.String("permission"), SourcePath: jsii.String("sourcePath"), }, }, }
type CfnComponentVersion_LambdaDeviceMountProperty ¶
type CfnComponentVersion_LambdaDeviceMountProperty struct { // Whether or not to add the component's system user as an owner of the device. // // Default: `false`. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-componentversion-lambdadevicemount.html#cfn-greengrassv2-componentversion-lambdadevicemount-addgroupowner // AddGroupOwner interface{} `field:"optional" json:"addGroupOwner" yaml:"addGroupOwner"` // The mount path for the device in the file system. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-componentversion-lambdadevicemount.html#cfn-greengrassv2-componentversion-lambdadevicemount-path // Path *string `field:"optional" json:"path" yaml:"path"` // The permission to access the device: read/only ( `ro` ) or read/write ( `rw` ). // // Default: `ro`. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-componentversion-lambdadevicemount.html#cfn-greengrassv2-componentversion-lambdadevicemount-permission // Permission *string `field:"optional" json:"permission" yaml:"permission"` }
Contains information about a device that Linux processes in a container can access.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" lambdaDeviceMountProperty := &LambdaDeviceMountProperty{ AddGroupOwner: jsii.Boolean(false), Path: jsii.String("path"), Permission: jsii.String("permission"), }
type CfnComponentVersion_LambdaEventSourceProperty ¶
type CfnComponentVersion_LambdaEventSourceProperty struct { // The topic to which to subscribe to receive event messages. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-componentversion-lambdaeventsource.html#cfn-greengrassv2-componentversion-lambdaeventsource-topic // Topic *string `field:"optional" json:"topic" yaml:"topic"` // The type of event source. Choose from the following options:. // // - `PUB_SUB` – Subscribe to local publish/subscribe messages. This event source type doesn't support MQTT wildcards ( `+` and `#` ) in the event source topic. // - `IOT_CORE` – Subscribe to AWS IoT Core MQTT messages. This event source type supports MQTT wildcards ( `+` and `#` ) in the event source topic. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-componentversion-lambdaeventsource.html#cfn-greengrassv2-componentversion-lambdaeventsource-type // Type *string `field:"optional" json:"type" yaml:"type"` }
Contains information about an event source for an AWS Lambda function.
The event source defines the topics on which this Lambda function subscribes to receive messages that run the function.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" lambdaEventSourceProperty := &LambdaEventSourceProperty{ Topic: jsii.String("topic"), Type: jsii.String("type"), }
type CfnComponentVersion_LambdaExecutionParametersProperty ¶
type CfnComponentVersion_LambdaExecutionParametersProperty struct { // The map of environment variables that are available to the Lambda function when it runs. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-componentversion-lambdaexecutionparameters.html#cfn-greengrassv2-componentversion-lambdaexecutionparameters-environmentvariables // EnvironmentVariables interface{} `field:"optional" json:"environmentVariables" yaml:"environmentVariables"` // The list of event sources to which to subscribe to receive work messages. // // The Lambda function runs when it receives a message from an event source. You can subscribe this function to local publish/subscribe messages and AWS IoT Core MQTT messages. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-componentversion-lambdaexecutionparameters.html#cfn-greengrassv2-componentversion-lambdaexecutionparameters-eventsources // EventSources interface{} `field:"optional" json:"eventSources" yaml:"eventSources"` // The list of arguments to pass to the Lambda function when it runs. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-componentversion-lambdaexecutionparameters.html#cfn-greengrassv2-componentversion-lambdaexecutionparameters-execargs // ExecArgs *[]*string `field:"optional" json:"execArgs" yaml:"execArgs"` // The encoding type that the Lambda function supports. // // Default: `json`. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-componentversion-lambdaexecutionparameters.html#cfn-greengrassv2-componentversion-lambdaexecutionparameters-inputpayloadencodingtype // InputPayloadEncodingType *string `field:"optional" json:"inputPayloadEncodingType" yaml:"inputPayloadEncodingType"` // The parameters for the Linux process that contains the Lambda function. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-componentversion-lambdaexecutionparameters.html#cfn-greengrassv2-componentversion-lambdaexecutionparameters-linuxprocessparams // LinuxProcessParams interface{} `field:"optional" json:"linuxProcessParams" yaml:"linuxProcessParams"` // The maximum amount of time in seconds that a non-pinned Lambda function can idle before the AWS IoT Greengrass Core software stops its process. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-componentversion-lambdaexecutionparameters.html#cfn-greengrassv2-componentversion-lambdaexecutionparameters-maxidletimeinseconds // MaxIdleTimeInSeconds *float64 `field:"optional" json:"maxIdleTimeInSeconds" yaml:"maxIdleTimeInSeconds"` // The maximum number of instances that a non-pinned Lambda function can run at the same time. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-componentversion-lambdaexecutionparameters.html#cfn-greengrassv2-componentversion-lambdaexecutionparameters-maxinstancescount // MaxInstancesCount *float64 `field:"optional" json:"maxInstancesCount" yaml:"maxInstancesCount"` // The maximum size of the message queue for the Lambda function component. // // The AWS IoT Greengrass core device stores messages in a FIFO (first-in-first-out) queue until it can run the Lambda function to consume each message. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-componentversion-lambdaexecutionparameters.html#cfn-greengrassv2-componentversion-lambdaexecutionparameters-maxqueuesize // MaxQueueSize *float64 `field:"optional" json:"maxQueueSize" yaml:"maxQueueSize"` // Whether or not the Lambda function is pinned, or long-lived. // // - A pinned Lambda function starts when the AWS IoT Greengrass Core starts and keeps running in its own container. // - A non-pinned Lambda function starts only when it receives a work item and exists after it idles for `maxIdleTimeInSeconds` . If the function has multiple work items, the AWS IoT Greengrass Core software creates multiple instances of the function. // // Default: `true`. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-componentversion-lambdaexecutionparameters.html#cfn-greengrassv2-componentversion-lambdaexecutionparameters-pinned // Pinned interface{} `field:"optional" json:"pinned" yaml:"pinned"` // The interval in seconds at which a pinned (also known as long-lived) Lambda function component sends status updates to the Lambda manager component. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-componentversion-lambdaexecutionparameters.html#cfn-greengrassv2-componentversion-lambdaexecutionparameters-statustimeoutinseconds // StatusTimeoutInSeconds *float64 `field:"optional" json:"statusTimeoutInSeconds" yaml:"statusTimeoutInSeconds"` // The maximum amount of time in seconds that the Lambda function can process a work item. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-componentversion-lambdaexecutionparameters.html#cfn-greengrassv2-componentversion-lambdaexecutionparameters-timeoutinseconds // TimeoutInSeconds *float64 `field:"optional" json:"timeoutInSeconds" yaml:"timeoutInSeconds"` }
Contains parameters for a Lambda function that runs on AWS IoT Greengrass .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" lambdaExecutionParametersProperty := &LambdaExecutionParametersProperty{ EnvironmentVariables: map[string]*string{ "environmentVariablesKey": jsii.String("environmentVariables"), }, EventSources: []interface{}{ &LambdaEventSourceProperty{ Topic: jsii.String("topic"), Type: jsii.String("type"), }, }, ExecArgs: []*string{ jsii.String("execArgs"), }, InputPayloadEncodingType: jsii.String("inputPayloadEncodingType"), LinuxProcessParams: &LambdaLinuxProcessParamsProperty{ ContainerParams: &LambdaContainerParamsProperty{ Devices: []interface{}{ &LambdaDeviceMountProperty{ AddGroupOwner: jsii.Boolean(false), Path: jsii.String("path"), Permission: jsii.String("permission"), }, }, MemorySizeInKb: jsii.Number(123), MountRoSysfs: jsii.Boolean(false), Volumes: []interface{}{ &LambdaVolumeMountProperty{ AddGroupOwner: jsii.Boolean(false), DestinationPath: jsii.String("destinationPath"), Permission: jsii.String("permission"), SourcePath: jsii.String("sourcePath"), }, }, }, IsolationMode: jsii.String("isolationMode"), }, MaxIdleTimeInSeconds: jsii.Number(123), MaxInstancesCount: jsii.Number(123), MaxQueueSize: jsii.Number(123), Pinned: jsii.Boolean(false), StatusTimeoutInSeconds: jsii.Number(123), TimeoutInSeconds: jsii.Number(123), }
type CfnComponentVersion_LambdaFunctionRecipeSourceProperty ¶
type CfnComponentVersion_LambdaFunctionRecipeSourceProperty struct { // The component versions on which this Lambda function component depends. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-componentversion-lambdafunctionrecipesource.html#cfn-greengrassv2-componentversion-lambdafunctionrecipesource-componentdependencies // ComponentDependencies interface{} `field:"optional" json:"componentDependencies" yaml:"componentDependencies"` // The system and runtime parameters for the Lambda function as it runs on the AWS IoT Greengrass core device. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-componentversion-lambdafunctionrecipesource.html#cfn-greengrassv2-componentversion-lambdafunctionrecipesource-componentlambdaparameters // ComponentLambdaParameters interface{} `field:"optional" json:"componentLambdaParameters" yaml:"componentLambdaParameters"` // The name of the component. // // Defaults to the name of the Lambda function. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-componentversion-lambdafunctionrecipesource.html#cfn-greengrassv2-componentversion-lambdafunctionrecipesource-componentname // ComponentName *string `field:"optional" json:"componentName" yaml:"componentName"` // The platforms that the component version supports. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-componentversion-lambdafunctionrecipesource.html#cfn-greengrassv2-componentversion-lambdafunctionrecipesource-componentplatforms // ComponentPlatforms interface{} `field:"optional" json:"componentPlatforms" yaml:"componentPlatforms"` // The version of the component. // // Defaults to the version of the Lambda function as a semantic version. For example, if your function version is `3` , the component version becomes `3.0.0` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-componentversion-lambdafunctionrecipesource.html#cfn-greengrassv2-componentversion-lambdafunctionrecipesource-componentversion // ComponentVersion *string `field:"optional" json:"componentVersion" yaml:"componentVersion"` // The ARN of the Lambda function. // // The ARN must include the version of the function to import. You can't use version aliases like `$LATEST` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-componentversion-lambdafunctionrecipesource.html#cfn-greengrassv2-componentversion-lambdafunctionrecipesource-lambdaarn // LambdaArn *string `field:"optional" json:"lambdaArn" yaml:"lambdaArn"` }
Contains information about an AWS Lambda function to import to create a component.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" lambdaFunctionRecipeSourceProperty := &LambdaFunctionRecipeSourceProperty{ ComponentDependencies: map[string]interface{}{ "componentDependenciesKey": &ComponentDependencyRequirementProperty{ "dependencyType": jsii.String("dependencyType"), "versionRequirement": jsii.String("versionRequirement"), }, }, ComponentLambdaParameters: &LambdaExecutionParametersProperty{ EnvironmentVariables: map[string]*string{ "environmentVariablesKey": jsii.String("environmentVariables"), }, EventSources: []interface{}{ &LambdaEventSourceProperty{ Topic: jsii.String("topic"), Type: jsii.String("type"), }, }, ExecArgs: []*string{ jsii.String("execArgs"), }, InputPayloadEncodingType: jsii.String("inputPayloadEncodingType"), LinuxProcessParams: &LambdaLinuxProcessParamsProperty{ ContainerParams: &LambdaContainerParamsProperty{ Devices: []interface{}{ &LambdaDeviceMountProperty{ AddGroupOwner: jsii.Boolean(false), Path: jsii.String("path"), Permission: jsii.String("permission"), }, }, MemorySizeInKb: jsii.Number(123), MountRoSysfs: jsii.Boolean(false), Volumes: []interface{}{ &LambdaVolumeMountProperty{ AddGroupOwner: jsii.Boolean(false), DestinationPath: jsii.String("destinationPath"), Permission: jsii.String("permission"), SourcePath: jsii.String("sourcePath"), }, }, }, IsolationMode: jsii.String("isolationMode"), }, MaxIdleTimeInSeconds: jsii.Number(123), MaxInstancesCount: jsii.Number(123), MaxQueueSize: jsii.Number(123), Pinned: jsii.Boolean(false), StatusTimeoutInSeconds: jsii.Number(123), TimeoutInSeconds: jsii.Number(123), }, ComponentName: jsii.String("componentName"), ComponentPlatforms: []interface{}{ &ComponentPlatformProperty{ Attributes: map[string]*string{ "attributesKey": jsii.String("attributes"), }, Name: jsii.String("name"), }, }, ComponentVersion: jsii.String("componentVersion"), LambdaArn: jsii.String("lambdaArn"), }
type CfnComponentVersion_LambdaLinuxProcessParamsProperty ¶
type CfnComponentVersion_LambdaLinuxProcessParamsProperty struct { // The parameters for the container in which the Lambda function runs. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-componentversion-lambdalinuxprocessparams.html#cfn-greengrassv2-componentversion-lambdalinuxprocessparams-containerparams // ContainerParams interface{} `field:"optional" json:"containerParams" yaml:"containerParams"` // The isolation mode for the process that contains the Lambda function. // // The process can run in an isolated runtime environment inside the AWS IoT Greengrass container, or as a regular process outside any container. // // Default: `GreengrassContainer`. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-componentversion-lambdalinuxprocessparams.html#cfn-greengrassv2-componentversion-lambdalinuxprocessparams-isolationmode // IsolationMode *string `field:"optional" json:"isolationMode" yaml:"isolationMode"` }
Contains parameters for a Linux process that contains an AWS Lambda function.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" lambdaLinuxProcessParamsProperty := &LambdaLinuxProcessParamsProperty{ ContainerParams: &LambdaContainerParamsProperty{ Devices: []interface{}{ &LambdaDeviceMountProperty{ AddGroupOwner: jsii.Boolean(false), Path: jsii.String("path"), Permission: jsii.String("permission"), }, }, MemorySizeInKb: jsii.Number(123), MountRoSysfs: jsii.Boolean(false), Volumes: []interface{}{ &LambdaVolumeMountProperty{ AddGroupOwner: jsii.Boolean(false), DestinationPath: jsii.String("destinationPath"), Permission: jsii.String("permission"), SourcePath: jsii.String("sourcePath"), }, }, }, IsolationMode: jsii.String("isolationMode"), }
type CfnComponentVersion_LambdaVolumeMountProperty ¶
type CfnComponentVersion_LambdaVolumeMountProperty struct { // Whether or not to add the AWS IoT Greengrass user group as an owner of the volume. // // Default: `false`. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-componentversion-lambdavolumemount.html#cfn-greengrassv2-componentversion-lambdavolumemount-addgroupowner // AddGroupOwner interface{} `field:"optional" json:"addGroupOwner" yaml:"addGroupOwner"` // The path to the logical volume in the file system. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-componentversion-lambdavolumemount.html#cfn-greengrassv2-componentversion-lambdavolumemount-destinationpath // DestinationPath *string `field:"optional" json:"destinationPath" yaml:"destinationPath"` // The permission to access the volume: read/only ( `ro` ) or read/write ( `rw` ). // // Default: `ro`. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-componentversion-lambdavolumemount.html#cfn-greengrassv2-componentversion-lambdavolumemount-permission // Permission *string `field:"optional" json:"permission" yaml:"permission"` // The path to the physical volume in the file system. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-componentversion-lambdavolumemount.html#cfn-greengrassv2-componentversion-lambdavolumemount-sourcepath // SourcePath *string `field:"optional" json:"sourcePath" yaml:"sourcePath"` }
Contains information about a volume that Linux processes in a container can access.
When you define a volume, the AWS IoT Greengrass Core software mounts the source files to the destination inside the container.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" lambdaVolumeMountProperty := &LambdaVolumeMountProperty{ AddGroupOwner: jsii.Boolean(false), DestinationPath: jsii.String("destinationPath"), Permission: jsii.String("permission"), SourcePath: jsii.String("sourcePath"), }
type CfnDeployment ¶ added in v2.46.0
type CfnDeployment interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable // The ID of the deployment. AttrDeploymentId() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // The components to deploy. Components() interface{} SetComponents(val interface{}) // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The name of the deployment. DeploymentName() *string SetDeploymentName(val *string) // The deployment policies for the deployment. DeploymentPolicies() interface{} SetDeploymentPolicies(val interface{}) // The job configuration for the deployment configuration. IotJobConfiguration() interface{} SetIotJobConfiguration(val interface{}) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node // The parent deployment's [ARN](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) for a subdeployment. ParentTargetArn() *string SetParentTargetArn(val *string) // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // Application-specific metadata to attach to the deployment. TagsRaw() *map[string]*string SetTagsRaw(val *map[string]*string) // The ARN of the target AWS IoT thing or thing group. TargetArn() *string SetTargetArn(val *string) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
Creates a continuous deployment for a target, which is a AWS IoT Greengrass core device or group of core devices.
When you add a new core device to a group of core devices that has a deployment, AWS IoT Greengrass deploys that group's deployment to the new device.
You can define one deployment for each target. When you create a new deployment for a target that has an existing deployment, you replace the previous deployment. AWS IoT Greengrass applies the new deployment to the target devices.
You can only add, update, or delete up to 10 deployments at a time to a single target.
Every deployment has a revision number that indicates how many deployment revisions you define for a target. Use this operation to create a new revision of an existing deployment. This operation returns the revision number of the new deployment when you create it.
For more information, see the [Create deployments](https://docs.aws.amazon.com/greengrass/v2/developerguide/create-deployments.html) in the *AWS IoT Greengrass V2 Developer Guide* .
> Deployment resources are deleted when you delete stacks. To keep the deployments in a stack, you must specify `"DeletionPolicy": "Retain"` on each deployment resource in the stack template that you want to keep. For more information, see [DeletionPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html) . > > You can only delete up to 10 deployment resources at a time. If you delete more than 10 resources, you receive an error.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" var rateIncreaseCriteria interface{} cfnDeployment := awscdk.Aws_greengrassv2.NewCfnDeployment(this, jsii.String("MyCfnDeployment"), &CfnDeploymentProps{ TargetArn: jsii.String("targetArn"), // the properties below are optional Components: map[string]interface{}{ "componentsKey": &ComponentDeploymentSpecificationProperty{ "componentVersion": jsii.String("componentVersion"), "configurationUpdate": &ComponentConfigurationUpdateProperty{ "merge": jsii.String("merge"), "reset": []*string{ jsii.String("reset"), }, }, "runWith": &ComponentRunWithProperty{ "posixUser": jsii.String("posixUser"), "systemResourceLimits": &SystemResourceLimitsProperty{ "cpus": jsii.Number(123), "memory": jsii.Number(123), }, "windowsUser": jsii.String("windowsUser"), }, }, }, DeploymentName: jsii.String("deploymentName"), DeploymentPolicies: &DeploymentPoliciesProperty{ ComponentUpdatePolicy: &DeploymentComponentUpdatePolicyProperty{ Action: jsii.String("action"), TimeoutInSeconds: jsii.Number(123), }, ConfigurationValidationPolicy: &DeploymentConfigurationValidationPolicyProperty{ TimeoutInSeconds: jsii.Number(123), }, FailureHandlingPolicy: jsii.String("failureHandlingPolicy"), }, IotJobConfiguration: &DeploymentIoTJobConfigurationProperty{ AbortConfig: &IoTJobAbortConfigProperty{ CriteriaList: []interface{}{ &IoTJobAbortCriteriaProperty{ Action: jsii.String("action"), FailureType: jsii.String("failureType"), MinNumberOfExecutedThings: jsii.Number(123), ThresholdPercentage: jsii.Number(123), }, }, }, JobExecutionsRolloutConfig: &IoTJobExecutionsRolloutConfigProperty{ ExponentialRate: &IoTJobExponentialRolloutRateProperty{ BaseRatePerMinute: jsii.Number(123), IncrementFactor: jsii.Number(123), RateIncreaseCriteria: rateIncreaseCriteria, }, MaximumPerMinute: jsii.Number(123), }, TimeoutConfig: &IoTJobTimeoutConfigProperty{ InProgressTimeoutInMinutes: jsii.Number(123), }, }, ParentTargetArn: jsii.String("parentTargetArn"), Tags: map[string]*string{ "tagsKey": jsii.String("tags"), }, })
func NewCfnDeployment ¶ added in v2.46.0
func NewCfnDeployment(scope constructs.Construct, id *string, props *CfnDeploymentProps) CfnDeployment
type CfnDeploymentProps ¶ added in v2.46.0
type CfnDeploymentProps struct { // The ARN of the target AWS IoT thing or thing group. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrassv2-deployment.html#cfn-greengrassv2-deployment-targetarn // TargetArn *string `field:"required" json:"targetArn" yaml:"targetArn"` // The components to deploy. // // This is a dictionary, where each key is the name of a component, and each key's value is the version and configuration to deploy for that component. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrassv2-deployment.html#cfn-greengrassv2-deployment-components // Components interface{} `field:"optional" json:"components" yaml:"components"` // The name of the deployment. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrassv2-deployment.html#cfn-greengrassv2-deployment-deploymentname // DeploymentName *string `field:"optional" json:"deploymentName" yaml:"deploymentName"` // The deployment policies for the deployment. // // These policies define how the deployment updates components and handles failure. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrassv2-deployment.html#cfn-greengrassv2-deployment-deploymentpolicies // DeploymentPolicies interface{} `field:"optional" json:"deploymentPolicies" yaml:"deploymentPolicies"` // The job configuration for the deployment configuration. // // The job configuration specifies the rollout, timeout, and stop configurations for the deployment configuration. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrassv2-deployment.html#cfn-greengrassv2-deployment-iotjobconfiguration // IotJobConfiguration interface{} `field:"optional" json:"iotJobConfiguration" yaml:"iotJobConfiguration"` // The parent deployment's [ARN](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) for a subdeployment. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrassv2-deployment.html#cfn-greengrassv2-deployment-parenttargetarn // ParentTargetArn *string `field:"optional" json:"parentTargetArn" yaml:"parentTargetArn"` // Application-specific metadata to attach to the deployment. // // 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 [Tag your AWS IoT Greengrass Version 2 resources](https://docs.aws.amazon.com/greengrass/v2/developerguide/tag-resources.html) in the *AWS IoT Greengrass V2 Developer Guide* . // // This `Json` property type is processed as a map of key-value pairs. It uses the following format, which is different from most `Tags` implementations in AWS CloudFormation templates. // // “`json // "Tags": { "KeyName0": "value", "KeyName1": "value", "KeyName2": "value" // } // “`. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrassv2-deployment.html#cfn-greengrassv2-deployment-tags // Tags *map[string]*string `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnDeployment`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" var rateIncreaseCriteria interface{} cfnDeploymentProps := &CfnDeploymentProps{ TargetArn: jsii.String("targetArn"), // the properties below are optional Components: map[string]interface{}{ "componentsKey": &ComponentDeploymentSpecificationProperty{ "componentVersion": jsii.String("componentVersion"), "configurationUpdate": &ComponentConfigurationUpdateProperty{ "merge": jsii.String("merge"), "reset": []*string{ jsii.String("reset"), }, }, "runWith": &ComponentRunWithProperty{ "posixUser": jsii.String("posixUser"), "systemResourceLimits": &SystemResourceLimitsProperty{ "cpus": jsii.Number(123), "memory": jsii.Number(123), }, "windowsUser": jsii.String("windowsUser"), }, }, }, DeploymentName: jsii.String("deploymentName"), DeploymentPolicies: &DeploymentPoliciesProperty{ ComponentUpdatePolicy: &DeploymentComponentUpdatePolicyProperty{ Action: jsii.String("action"), TimeoutInSeconds: jsii.Number(123), }, ConfigurationValidationPolicy: &DeploymentConfigurationValidationPolicyProperty{ TimeoutInSeconds: jsii.Number(123), }, FailureHandlingPolicy: jsii.String("failureHandlingPolicy"), }, IotJobConfiguration: &DeploymentIoTJobConfigurationProperty{ AbortConfig: &IoTJobAbortConfigProperty{ CriteriaList: []interface{}{ &IoTJobAbortCriteriaProperty{ Action: jsii.String("action"), FailureType: jsii.String("failureType"), MinNumberOfExecutedThings: jsii.Number(123), ThresholdPercentage: jsii.Number(123), }, }, }, JobExecutionsRolloutConfig: &IoTJobExecutionsRolloutConfigProperty{ ExponentialRate: &IoTJobExponentialRolloutRateProperty{ BaseRatePerMinute: jsii.Number(123), IncrementFactor: jsii.Number(123), RateIncreaseCriteria: rateIncreaseCriteria, }, MaximumPerMinute: jsii.Number(123), }, TimeoutConfig: &IoTJobTimeoutConfigProperty{ InProgressTimeoutInMinutes: jsii.Number(123), }, }, ParentTargetArn: jsii.String("parentTargetArn"), Tags: map[string]*string{ "tagsKey": jsii.String("tags"), }, }
type CfnDeployment_ComponentConfigurationUpdateProperty ¶ added in v2.46.0
type CfnDeployment_ComponentConfigurationUpdateProperty struct { // A serialized JSON string that contains the configuration object to merge to target devices. // // The core device merges this configuration with the component's existing configuration. If this is the first time a component deploys on a device, the core device merges this configuration with the component's default configuration. This means that the core device keeps it's existing configuration for keys and values that you don't specify in this object. For more information, see [Merge configuration updates](https://docs.aws.amazon.com/greengrass/v2/developerguide/update-component-configurations.html#merge-configuration-update) in the *AWS IoT Greengrass V2 Developer Guide* . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-componentconfigurationupdate.html#cfn-greengrassv2-deployment-componentconfigurationupdate-merge // Merge *string `field:"optional" json:"merge" yaml:"merge"` // The list of configuration nodes to reset to default values on target devices. // // Use JSON pointers to specify each node to reset. JSON pointers start with a forward slash ( `/` ) and use forward slashes to separate the key for each level in the object. For more information, see the [JSON pointer specification](https://docs.aws.amazon.com/https://tools.ietf.org/html/rfc6901) and [Reset configuration updates](https://docs.aws.amazon.com/greengrass/v2/developerguide/update-component-configurations.html#reset-configuration-update) in the *AWS IoT Greengrass V2 Developer Guide* . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-componentconfigurationupdate.html#cfn-greengrassv2-deployment-componentconfigurationupdate-reset // Reset *[]*string `field:"optional" json:"reset" yaml:"reset"` }
Contains information about a deployment's update to a component's configuration on AWS IoT Greengrass core devices.
For more information, see [Update component configurations](https://docs.aws.amazon.com/greengrass/v2/developerguide/update-component-configurations.html) in the *AWS IoT Greengrass V2 Developer Guide* .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" componentConfigurationUpdateProperty := &ComponentConfigurationUpdateProperty{ Merge: jsii.String("merge"), Reset: []*string{ jsii.String("reset"), }, }
type CfnDeployment_ComponentDeploymentSpecificationProperty ¶ added in v2.46.0
type CfnDeployment_ComponentDeploymentSpecificationProperty struct { // The version of the component. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-componentdeploymentspecification.html#cfn-greengrassv2-deployment-componentdeploymentspecification-componentversion // ComponentVersion *string `field:"optional" json:"componentVersion" yaml:"componentVersion"` // The configuration updates to deploy for the component. // // You can define reset updates and merge updates. A reset updates the keys that you specify to the default configuration for the component. A merge updates the core device's component configuration with the keys and values that you specify. The AWS IoT Greengrass Core software applies reset updates before it applies merge updates. For more information, see [Update component configuration](https://docs.aws.amazon.com/greengrass/v2/developerguide/update-component-configurations.html) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-componentdeploymentspecification.html#cfn-greengrassv2-deployment-componentdeploymentspecification-configurationupdate // ConfigurationUpdate interface{} `field:"optional" json:"configurationUpdate" yaml:"configurationUpdate"` // The system user and group that the software uses to run component processes on the core device. // // If you omit this parameter, the software uses the system user and group that you configure for the core device. For more information, see [Configure the user and group that run components](https://docs.aws.amazon.com/greengrass/v2/developerguide/configure-greengrass-core-v2.html#configure-component-user) in the *AWS IoT Greengrass V2 Developer Guide* . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-componentdeploymentspecification.html#cfn-greengrassv2-deployment-componentdeploymentspecification-runwith // RunWith interface{} `field:"optional" json:"runWith" yaml:"runWith"` }
Contains information about a component to deploy.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" componentDeploymentSpecificationProperty := &ComponentDeploymentSpecificationProperty{ ComponentVersion: jsii.String("componentVersion"), ConfigurationUpdate: &ComponentConfigurationUpdateProperty{ Merge: jsii.String("merge"), Reset: []*string{ jsii.String("reset"), }, }, RunWith: &ComponentRunWithProperty{ PosixUser: jsii.String("posixUser"), SystemResourceLimits: &SystemResourceLimitsProperty{ Cpus: jsii.Number(123), Memory: jsii.Number(123), }, WindowsUser: jsii.String("windowsUser"), }, }
type CfnDeployment_ComponentRunWithProperty ¶ added in v2.46.0
type CfnDeployment_ComponentRunWithProperty struct { // The POSIX system user and (optional) group to use to run this component. // // Specify the user and group separated by a colon ( `:` ) in the following format: `user:group` . The group is optional. If you don't specify a group, the AWS IoT Greengrass Core software uses the primary user for the group. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-componentrunwith.html#cfn-greengrassv2-deployment-componentrunwith-posixuser // PosixUser *string `field:"optional" json:"posixUser" yaml:"posixUser"` // The system resource limits to apply to this component's process on the core device. // // AWS IoT Greengrass supports this feature only on Linux core devices. // // If you omit this parameter, the AWS IoT Greengrass Core software uses the default system resource limits that you configure on the AWS IoT Greengrass nucleus component. For more information, see [Configure system resource limits for components](https://docs.aws.amazon.com/greengrass/v2/developerguide/configure-greengrass-core-v2.html#configure-component-system-resource-limits) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-componentrunwith.html#cfn-greengrassv2-deployment-componentrunwith-systemresourcelimits // SystemResourceLimits interface{} `field:"optional" json:"systemResourceLimits" yaml:"systemResourceLimits"` // The Windows user to use to run this component on Windows core devices. // // The user must exist on each Windows core device, and its name and password must be in the LocalSystem account's Credentials Manager instance. // // If you omit this parameter, the AWS IoT Greengrass Core software uses the default Windows user that you configure on the AWS IoT Greengrass nucleus component. For more information, see [Configure the user and group that run components](https://docs.aws.amazon.com/greengrass/v2/developerguide/configure-greengrass-core-v2.html#configure-component-user) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-componentrunwith.html#cfn-greengrassv2-deployment-componentrunwith-windowsuser // WindowsUser *string `field:"optional" json:"windowsUser" yaml:"windowsUser"` }
Contains information system user and group that the AWS IoT Greengrass Core software uses to run component processes on the core device.
For more information, see [Configure the user and group that run components](https://docs.aws.amazon.com/greengrass/v2/developerguide/configure-greengrass-core-v2.html#configure-component-user) in the *AWS IoT Greengrass V2 Developer Guide* .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" componentRunWithProperty := &ComponentRunWithProperty{ PosixUser: jsii.String("posixUser"), SystemResourceLimits: &SystemResourceLimitsProperty{ Cpus: jsii.Number(123), Memory: jsii.Number(123), }, WindowsUser: jsii.String("windowsUser"), }
type CfnDeployment_DeploymentComponentUpdatePolicyProperty ¶ added in v2.46.0
type CfnDeployment_DeploymentComponentUpdatePolicyProperty struct { // Whether or not to notify components and wait for components to become safe to update. // // Choose from the following options: // // - `NOTIFY_COMPONENTS` – The deployment notifies each component before it stops and updates that component. Components can use the [SubscribeToComponentUpdates](https://docs.aws.amazon.com/greengrass/v2/developerguide/interprocess-communication.html#ipc-operation-subscribetocomponentupdates) IPC operation to receive these notifications. Then, components can respond with the [DeferComponentUpdate](https://docs.aws.amazon.com/greengrass/v2/developerguide/interprocess-communication.html#ipc-operation-defercomponentupdate) IPC operation. For more information, see the [Create deployments](https://docs.aws.amazon.com/greengrass/v2/developerguide/create-deployments.html) in the *AWS IoT Greengrass V2 Developer Guide* . // - `SKIP_NOTIFY_COMPONENTS` – The deployment doesn't notify components or wait for them to be safe to update. // // Default: `NOTIFY_COMPONENTS`. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-deploymentcomponentupdatepolicy.html#cfn-greengrassv2-deployment-deploymentcomponentupdatepolicy-action // Action *string `field:"optional" json:"action" yaml:"action"` // The amount of time in seconds that each component on a device has to report that it's safe to update. // // If the component waits for longer than this timeout, then the deployment proceeds on the device. // // Default: `60`. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-deploymentcomponentupdatepolicy.html#cfn-greengrassv2-deployment-deploymentcomponentupdatepolicy-timeoutinseconds // TimeoutInSeconds *float64 `field:"optional" json:"timeoutInSeconds" yaml:"timeoutInSeconds"` }
Contains information about a deployment's policy that defines when components are safe to update.
Each component on a device can report whether or not it's ready to update. After a component and its dependencies are ready, they can apply the update in the deployment. You can configure whether or not the deployment notifies components of an update and waits for a response. You specify the amount of time each component has to respond to the update notification.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" deploymentComponentUpdatePolicyProperty := &DeploymentComponentUpdatePolicyProperty{ Action: jsii.String("action"), TimeoutInSeconds: jsii.Number(123), }
type CfnDeployment_DeploymentConfigurationValidationPolicyProperty ¶ added in v2.46.0
type CfnDeployment_DeploymentConfigurationValidationPolicyProperty struct { // The amount of time in seconds that a component can validate its configuration updates. // // If the validation time exceeds this timeout, then the deployment proceeds for the device. // // Default: `30`. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-deploymentconfigurationvalidationpolicy.html#cfn-greengrassv2-deployment-deploymentconfigurationvalidationpolicy-timeoutinseconds // TimeoutInSeconds *float64 `field:"optional" json:"timeoutInSeconds" yaml:"timeoutInSeconds"` }
Contains information about how long a component on a core device can validate its configuration updates before it times out.
Components can use the [SubscribeToValidateConfigurationUpdates](https://docs.aws.amazon.com/greengrass/v2/developerguide/interprocess-communication.html#ipc-operation-subscribetovalidateconfigurationupdates) IPC operation to receive notifications when a deployment specifies a configuration update. Then, components can respond with the [SendConfigurationValidityReport](https://docs.aws.amazon.com/greengrass/v2/developerguide/interprocess-communication.html#ipc-operation-sendconfigurationvalidityreport) IPC operation. For more information, see the [Create deployments](https://docs.aws.amazon.com/greengrass/v2/developerguide/create-deployments.html) in the *AWS IoT Greengrass V2 Developer Guide* .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" deploymentConfigurationValidationPolicyProperty := &DeploymentConfigurationValidationPolicyProperty{ TimeoutInSeconds: jsii.Number(123), }
type CfnDeployment_DeploymentIoTJobConfigurationProperty ¶ added in v2.46.0
type CfnDeployment_DeploymentIoTJobConfigurationProperty struct { // The stop configuration for the job. // // This configuration defines when and how to stop a job rollout. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-deploymentiotjobconfiguration.html#cfn-greengrassv2-deployment-deploymentiotjobconfiguration-abortconfig // AbortConfig interface{} `field:"optional" json:"abortConfig" yaml:"abortConfig"` // The rollout configuration for the job. // // This configuration defines the rate at which the job rolls out to the fleet of target devices. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-deploymentiotjobconfiguration.html#cfn-greengrassv2-deployment-deploymentiotjobconfiguration-jobexecutionsrolloutconfig // JobExecutionsRolloutConfig interface{} `field:"optional" json:"jobExecutionsRolloutConfig" yaml:"jobExecutionsRolloutConfig"` // The timeout configuration for the job. // // This configuration defines the amount of time each device has to complete the job. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-deploymentiotjobconfiguration.html#cfn-greengrassv2-deployment-deploymentiotjobconfiguration-timeoutconfig // TimeoutConfig interface{} `field:"optional" json:"timeoutConfig" yaml:"timeoutConfig"` }
Contains information about an AWS IoT job configuration.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" var rateIncreaseCriteria interface{} deploymentIoTJobConfigurationProperty := &DeploymentIoTJobConfigurationProperty{ AbortConfig: &IoTJobAbortConfigProperty{ CriteriaList: []interface{}{ &IoTJobAbortCriteriaProperty{ Action: jsii.String("action"), FailureType: jsii.String("failureType"), MinNumberOfExecutedThings: jsii.Number(123), ThresholdPercentage: jsii.Number(123), }, }, }, JobExecutionsRolloutConfig: &IoTJobExecutionsRolloutConfigProperty{ ExponentialRate: &IoTJobExponentialRolloutRateProperty{ BaseRatePerMinute: jsii.Number(123), IncrementFactor: jsii.Number(123), RateIncreaseCriteria: rateIncreaseCriteria, }, MaximumPerMinute: jsii.Number(123), }, TimeoutConfig: &IoTJobTimeoutConfigProperty{ InProgressTimeoutInMinutes: jsii.Number(123), }, }
type CfnDeployment_DeploymentPoliciesProperty ¶ added in v2.46.0
type CfnDeployment_DeploymentPoliciesProperty struct { // The component update policy for the configuration deployment. // // This policy defines when it's safe to deploy the configuration to devices. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-deploymentpolicies.html#cfn-greengrassv2-deployment-deploymentpolicies-componentupdatepolicy // ComponentUpdatePolicy interface{} `field:"optional" json:"componentUpdatePolicy" yaml:"componentUpdatePolicy"` // The configuration validation policy for the configuration deployment. // // This policy defines how long each component has to validate its configure updates. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-deploymentpolicies.html#cfn-greengrassv2-deployment-deploymentpolicies-configurationvalidationpolicy // ConfigurationValidationPolicy interface{} `field:"optional" json:"configurationValidationPolicy" yaml:"configurationValidationPolicy"` // The failure handling policy for the configuration deployment. This policy defines what to do if the deployment fails. // // Default: `ROLLBACK`. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-deploymentpolicies.html#cfn-greengrassv2-deployment-deploymentpolicies-failurehandlingpolicy // FailureHandlingPolicy *string `field:"optional" json:"failureHandlingPolicy" yaml:"failureHandlingPolicy"` }
Contains information about policies that define how a deployment updates components and handles failure.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" deploymentPoliciesProperty := &DeploymentPoliciesProperty{ ComponentUpdatePolicy: &DeploymentComponentUpdatePolicyProperty{ Action: jsii.String("action"), TimeoutInSeconds: jsii.Number(123), }, ConfigurationValidationPolicy: &DeploymentConfigurationValidationPolicyProperty{ TimeoutInSeconds: jsii.Number(123), }, FailureHandlingPolicy: jsii.String("failureHandlingPolicy"), }
type CfnDeployment_IoTJobAbortConfigProperty ¶ added in v2.46.0
type CfnDeployment_IoTJobAbortConfigProperty struct { // The list of criteria that define when and how to cancel the configuration deployment. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-iotjobabortconfig.html#cfn-greengrassv2-deployment-iotjobabortconfig-criterialist // CriteriaList interface{} `field:"required" json:"criteriaList" yaml:"criteriaList"` }
Contains a list of criteria that define when and how to cancel a configuration deployment.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" ioTJobAbortConfigProperty := &IoTJobAbortConfigProperty{ CriteriaList: []interface{}{ &IoTJobAbortCriteriaProperty{ Action: jsii.String("action"), FailureType: jsii.String("failureType"), MinNumberOfExecutedThings: jsii.Number(123), ThresholdPercentage: jsii.Number(123), }, }, }
type CfnDeployment_IoTJobAbortCriteriaProperty ¶ added in v2.46.0
type CfnDeployment_IoTJobAbortCriteriaProperty struct { // The action to perform when the criteria are met. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-iotjobabortcriteria.html#cfn-greengrassv2-deployment-iotjobabortcriteria-action // Action *string `field:"required" json:"action" yaml:"action"` // The type of job deployment failure that can cancel a job. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-iotjobabortcriteria.html#cfn-greengrassv2-deployment-iotjobabortcriteria-failuretype // FailureType *string `field:"required" json:"failureType" yaml:"failureType"` // The minimum number of things that receive the configuration before the job can cancel. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-iotjobabortcriteria.html#cfn-greengrassv2-deployment-iotjobabortcriteria-minnumberofexecutedthings // MinNumberOfExecutedThings *float64 `field:"required" json:"minNumberOfExecutedThings" yaml:"minNumberOfExecutedThings"` // The minimum percentage of `failureType` failures that occur before the job can cancel. // // This parameter supports up to two digits after the decimal (for example, you can specify `10.9` or `10.99` , but not `10.999` ). // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-iotjobabortcriteria.html#cfn-greengrassv2-deployment-iotjobabortcriteria-thresholdpercentage // ThresholdPercentage *float64 `field:"required" json:"thresholdPercentage" yaml:"thresholdPercentage"` }
Contains criteria that define when and how to cancel a job.
The deployment stops if the following conditions are true:
- The number of things that receive the deployment exceeds the `minNumberOfExecutedThings` . - The percentage of failures with type `failureType` exceeds the `thresholdPercentage` .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" ioTJobAbortCriteriaProperty := &IoTJobAbortCriteriaProperty{ Action: jsii.String("action"), FailureType: jsii.String("failureType"), MinNumberOfExecutedThings: jsii.Number(123), ThresholdPercentage: jsii.Number(123), }
type CfnDeployment_IoTJobExecutionsRolloutConfigProperty ¶ added in v2.46.0
type CfnDeployment_IoTJobExecutionsRolloutConfigProperty struct { // The exponential rate to increase the job rollout rate. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-iotjobexecutionsrolloutconfig.html#cfn-greengrassv2-deployment-iotjobexecutionsrolloutconfig-exponentialrate // ExponentialRate interface{} `field:"optional" json:"exponentialRate" yaml:"exponentialRate"` // The maximum number of devices that receive a pending job notification, per minute. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-iotjobexecutionsrolloutconfig.html#cfn-greengrassv2-deployment-iotjobexecutionsrolloutconfig-maximumperminute // MaximumPerMinute *float64 `field:"optional" json:"maximumPerMinute" yaml:"maximumPerMinute"` }
Contains information about the rollout configuration for a job.
This configuration defines the rate at which the job deploys a configuration to a fleet of target devices.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" var rateIncreaseCriteria interface{} ioTJobExecutionsRolloutConfigProperty := &IoTJobExecutionsRolloutConfigProperty{ ExponentialRate: &IoTJobExponentialRolloutRateProperty{ BaseRatePerMinute: jsii.Number(123), IncrementFactor: jsii.Number(123), RateIncreaseCriteria: rateIncreaseCriteria, }, MaximumPerMinute: jsii.Number(123), }
type CfnDeployment_IoTJobExponentialRolloutRateProperty ¶ added in v2.46.0
type CfnDeployment_IoTJobExponentialRolloutRateProperty struct { // The minimum number of devices that receive a pending job notification, per minute, when the job starts. // // This parameter defines the initial rollout rate of the job. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-iotjobexponentialrolloutrate.html#cfn-greengrassv2-deployment-iotjobexponentialrolloutrate-baserateperminute // BaseRatePerMinute *float64 `field:"required" json:"baseRatePerMinute" yaml:"baseRatePerMinute"` // The exponential factor to increase the rollout rate for the job. // // This parameter supports up to one digit after the decimal (for example, you can specify `1.5` , but not `1.55` ). // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-iotjobexponentialrolloutrate.html#cfn-greengrassv2-deployment-iotjobexponentialrolloutrate-incrementfactor // IncrementFactor *float64 `field:"required" json:"incrementFactor" yaml:"incrementFactor"` // The criteria to increase the rollout rate for the job. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-iotjobexponentialrolloutrate.html#cfn-greengrassv2-deployment-iotjobexponentialrolloutrate-rateincreasecriteria // RateIncreaseCriteria interface{} `field:"required" json:"rateIncreaseCriteria" yaml:"rateIncreaseCriteria"` }
Contains information about an exponential rollout rate for a configuration deployment job.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" var rateIncreaseCriteria interface{} ioTJobExponentialRolloutRateProperty := &IoTJobExponentialRolloutRateProperty{ BaseRatePerMinute: jsii.Number(123), IncrementFactor: jsii.Number(123), RateIncreaseCriteria: rateIncreaseCriteria, }
type CfnDeployment_IoTJobTimeoutConfigProperty ¶ added in v2.46.0
type CfnDeployment_IoTJobTimeoutConfigProperty struct { // The amount of time, in minutes, that devices have to complete the job. // // The timer starts when the job status is set to `IN_PROGRESS` . If the job status doesn't change to a terminal state before the time expires, then the job status is set to `TIMED_OUT` . // // The timeout interval must be between 1 minute and 7 days (10080 minutes). // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-iotjobtimeoutconfig.html#cfn-greengrassv2-deployment-iotjobtimeoutconfig-inprogresstimeoutinminutes // InProgressTimeoutInMinutes *float64 `field:"optional" json:"inProgressTimeoutInMinutes" yaml:"inProgressTimeoutInMinutes"` }
Contains information about the timeout configuration for a job.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" ioTJobTimeoutConfigProperty := &IoTJobTimeoutConfigProperty{ InProgressTimeoutInMinutes: jsii.Number(123), }
type CfnDeployment_SystemResourceLimitsProperty ¶ added in v2.46.0
type CfnDeployment_SystemResourceLimitsProperty struct { // The maximum amount of CPU time that a component's processes can use on the core device. // // A core device's total CPU time is equivalent to the device's number of CPU cores. For example, on a core device with 4 CPU cores, you can set this value to 2 to limit the component's processes to 50 percent usage of each CPU core. On a device with 1 CPU core, you can set this value to 0.25 to limit the component's processes to 25 percent usage of the CPU. If you set this value to a number greater than the number of CPU cores, the AWS IoT Greengrass Core software doesn't limit the component's CPU usage. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-systemresourcelimits.html#cfn-greengrassv2-deployment-systemresourcelimits-cpus // Cpus *float64 `field:"optional" json:"cpus" yaml:"cpus"` // The maximum amount of RAM, expressed in kilobytes, that a component's processes can use on the core device. // // For more information, see [Configure system resource limits for components](https://docs.aws.amazon.com/greengrass/v2/developerguide/configure-greengrass-core-v2.html#configure-component-system-resource-limits) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-systemresourcelimits.html#cfn-greengrassv2-deployment-systemresourcelimits-memory // Memory *float64 `field:"optional" json:"memory" yaml:"memory"` }
Contains information about system resource limits that the software applies to a component's processes.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" systemResourceLimitsProperty := &SystemResourceLimitsProperty{ Cpus: jsii.Number(123), Memory: jsii.Number(123), }
Source Files ¶
- CfnComponentVersion.go
- CfnComponentVersionProps.go
- CfnComponentVersion_ComponentDependencyRequirementProperty.go
- CfnComponentVersion_ComponentPlatformProperty.go
- CfnComponentVersion_LambdaContainerParamsProperty.go
- CfnComponentVersion_LambdaDeviceMountProperty.go
- CfnComponentVersion_LambdaEventSourceProperty.go
- CfnComponentVersion_LambdaExecutionParametersProperty.go
- CfnComponentVersion_LambdaFunctionRecipeSourceProperty.go
- CfnComponentVersion_LambdaLinuxProcessParamsProperty.go
- CfnComponentVersion_LambdaVolumeMountProperty.go
- CfnComponentVersion__checks.go
- CfnDeployment.go
- CfnDeploymentProps.go
- CfnDeployment_ComponentConfigurationUpdateProperty.go
- CfnDeployment_ComponentDeploymentSpecificationProperty.go
- CfnDeployment_ComponentRunWithProperty.go
- CfnDeployment_DeploymentComponentUpdatePolicyProperty.go
- CfnDeployment_DeploymentConfigurationValidationPolicyProperty.go
- CfnDeployment_DeploymentIoTJobConfigurationProperty.go
- CfnDeployment_DeploymentPoliciesProperty.go
- CfnDeployment_IoTJobAbortConfigProperty.go
- CfnDeployment_IoTJobAbortCriteriaProperty.go
- CfnDeployment_IoTJobExecutionsRolloutConfigProperty.go
- CfnDeployment_IoTJobExponentialRolloutRateProperty.go
- CfnDeployment_IoTJobTimeoutConfigProperty.go
- CfnDeployment_SystemResourceLimitsProperty.go
- CfnDeployment__checks.go
- main.go