Class: Aws::GreengrassV2::Types::CreateDeploymentRequest

Inherits:

Struct

• Object
• Struct
• Aws::GreengrassV2::Types::CreateDeploymentRequest

Includes:

Structure

Defined in:

lib/aws-sdk-greengrassv2/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #client_token ⇒ String

  A unique, case-sensitive identifier that you can provide to ensure that the request is idempotent.

• #components ⇒ Hash<String,Types::ComponentDeploymentSpecification>

  The components to deploy.

• #deployment_name ⇒ String

  The name of the deployment.

• #deployment_policies ⇒ Types::DeploymentPolicies

  The deployment policies for the deployment.

• #iot_job_configuration ⇒ Types::DeploymentIoTJobConfiguration

  The job configuration for the deployment configuration.

• #parent_target_arn ⇒ String

  The parent deployment’s target [ARN] within a subdeployment.

• #tags ⇒ Hash<String,String>

  A list of key-value pairs that contain metadata for the resource.

• #target_arn ⇒ String

  The [ARN] of the target IoT thing or thing group.

Instance Attribute Details

#client_token ⇒ String

A unique, case-sensitive identifier that you can provide to ensure that the request is idempotent. Idempotency means that the request is successfully processed only once, even if you send the request multiple times. When a request succeeds, and you specify the same client token for subsequent successful requests, the IoT Greengrass V2 service returns the successful response that it caches from the previous request. IoT Greengrass V2 caches successful responses for idempotent requests for up to 8 hours.

**A suitable default value is auto-generated.** You should normally not need to pass this option.

Returns:

• (String)

# File 'lib/aws-sdk-greengrassv2/types.rb', line 893

class CreateDeploymentRequest < Struct.new(
  :target_arn,
  :deployment_name,
  :components,
  :iot_job_configuration,
  :deployment_policies,
  :parent_target_arn,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#components ⇒ Hash<String,Types::ComponentDeploymentSpecification>

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.

Returns:

• (Hash<String,Types::ComponentDeploymentSpecification>)

# File 'lib/aws-sdk-greengrassv2/types.rb', line 893

class CreateDeploymentRequest < Struct.new(
  :target_arn,
  :deployment_name,
  :components,
  :iot_job_configuration,
  :deployment_policies,
  :parent_target_arn,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#deployment_name ⇒ String

The name of the deployment.

Returns:

• (String)

# File 'lib/aws-sdk-greengrassv2/types.rb', line 893

class CreateDeploymentRequest < Struct.new(
  :target_arn,
  :deployment_name,
  :components,
  :iot_job_configuration,
  :deployment_policies,
  :parent_target_arn,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#deployment_policies ⇒ Types::DeploymentPolicies

The deployment policies for the deployment. These policies define how the deployment updates components and handles failure.

Returns:

• (Types::DeploymentPolicies)

# File 'lib/aws-sdk-greengrassv2/types.rb', line 893

class CreateDeploymentRequest < Struct.new(
  :target_arn,
  :deployment_name,
  :components,
  :iot_job_configuration,
  :deployment_policies,
  :parent_target_arn,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#iot_job_configuration ⇒ Types::DeploymentIoTJobConfiguration

The job configuration for the deployment configuration. The job configuration specifies the rollout, timeout, and stop configurations for the deployment configuration.

Returns:

• (Types::DeploymentIoTJobConfiguration)

# File 'lib/aws-sdk-greengrassv2/types.rb', line 893

class CreateDeploymentRequest < Struct.new(
  :target_arn,
  :deployment_name,
  :components,
  :iot_job_configuration,
  :deployment_policies,
  :parent_target_arn,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#parent_target_arn ⇒ String

The parent deployment’s target [ARN] within a subdeployment.

[1]: docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html

Returns:

• (String)

# File 'lib/aws-sdk-greengrassv2/types.rb', line 893

class CreateDeploymentRequest < Struct.new(
  :target_arn,
  :deployment_name,
  :components,
  :iot_job_configuration,
  :deployment_policies,
  :parent_target_arn,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

A list of key-value pairs that contain metadata for the resource. For more information, see [Tag your resources] in the *IoT Greengrass V2 Developer Guide*.

[1]: docs.aws.amazon.com/greengrass/v2/developerguide/tag-resources.html

Returns:

• (Hash<String,String>)

# File 'lib/aws-sdk-greengrassv2/types.rb', line 893

class CreateDeploymentRequest < Struct.new(
  :target_arn,
  :deployment_name,
  :components,
  :iot_job_configuration,
  :deployment_policies,
  :parent_target_arn,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#target_arn ⇒ String

The [ARN] of the target IoT thing or thing group. When creating a subdeployment, the targetARN can only be a thing group.

[1]: docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html

Returns:

• (String)

# File 'lib/aws-sdk-greengrassv2/types.rb', line 893

class CreateDeploymentRequest < Struct.new(
  :target_arn,
  :deployment_name,
  :components,
  :iot_job_configuration,
  :deployment_policies,
  :parent_target_arn,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end