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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-greengrassv2/lib/aws-sdk-greengrassv2/types.rb

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_tokenString

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)


874
875
876
877
878
879
880
881
882
883
884
885
# File 'gems/aws-sdk-greengrassv2/lib/aws-sdk-greengrassv2/types.rb', line 874

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

#componentsHash<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:



874
875
876
877
878
879
880
881
882
883
884
885
# File 'gems/aws-sdk-greengrassv2/lib/aws-sdk-greengrassv2/types.rb', line 874

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_nameString

The name of the deployment.

Returns:

  • (String)


874
875
876
877
878
879
880
881
882
883
884
885
# File 'gems/aws-sdk-greengrassv2/lib/aws-sdk-greengrassv2/types.rb', line 874

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_policiesTypes::DeploymentPolicies

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



874
875
876
877
878
879
880
881
882
883
884
885
# File 'gems/aws-sdk-greengrassv2/lib/aws-sdk-greengrassv2/types.rb', line 874

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_configurationTypes::DeploymentIoTJobConfiguration

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



874
875
876
877
878
879
880
881
882
883
884
885
# File 'gems/aws-sdk-greengrassv2/lib/aws-sdk-greengrassv2/types.rb', line 874

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_arnString

The parent deployment's target ARN within a subdeployment.

Returns:

  • (String)


874
875
876
877
878
879
880
881
882
883
884
885
# File 'gems/aws-sdk-greengrassv2/lib/aws-sdk-greengrassv2/types.rb', line 874

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

#tagsHash<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.

Returns:

  • (Hash<String,String>)


874
875
876
877
878
879
880
881
882
883
884
885
# File 'gems/aws-sdk-greengrassv2/lib/aws-sdk-greengrassv2/types.rb', line 874

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_arnString

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

Returns:

  • (String)


874
875
876
877
878
879
880
881
882
883
884
885
# File 'gems/aws-sdk-greengrassv2/lib/aws-sdk-greengrassv2/types.rb', line 874

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