Class: Aws::GreengrassV2::Types::GetDeploymentResponse

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

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



1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
# File 'gems/aws-sdk-greengrassv2/lib/aws-sdk-greengrassv2/types.rb', line 1790

class GetDeploymentResponse < Struct.new(
  :target_arn,
  :revision_id,
  :deployment_id,
  :deployment_name,
  :deployment_status,
  :iot_job_id,
  :iot_job_arn,
  :components,
  :deployment_policies,
  :iot_job_configuration,
  :creation_timestamp,
  :is_latest_for_target,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#creation_timestampTime

The time at which the deployment was created, expressed in ISO 8601 format.

Returns:

  • (Time)


1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
# File 'gems/aws-sdk-greengrassv2/lib/aws-sdk-greengrassv2/types.rb', line 1790

class GetDeploymentResponse < Struct.new(
  :target_arn,
  :revision_id,
  :deployment_id,
  :deployment_name,
  :deployment_status,
  :iot_job_id,
  :iot_job_arn,
  :components,
  :deployment_policies,
  :iot_job_configuration,
  :creation_timestamp,
  :is_latest_for_target,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#deployment_idString

The ID of the deployment.

Returns:

  • (String)


1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
# File 'gems/aws-sdk-greengrassv2/lib/aws-sdk-greengrassv2/types.rb', line 1790

class GetDeploymentResponse < Struct.new(
  :target_arn,
  :revision_id,
  :deployment_id,
  :deployment_name,
  :deployment_status,
  :iot_job_id,
  :iot_job_arn,
  :components,
  :deployment_policies,
  :iot_job_configuration,
  :creation_timestamp,
  :is_latest_for_target,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#deployment_nameString

The name of the deployment.

You can create deployments without names. If you create a deployment without a name, the AWS IoT Greengrass V2 console shows the deployment name as <targetType>:<targetName>, where targetType and targetName are the type and name of the deployment target.

Returns:

  • (String)


1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
# File 'gems/aws-sdk-greengrassv2/lib/aws-sdk-greengrassv2/types.rb', line 1790

class GetDeploymentResponse < Struct.new(
  :target_arn,
  :revision_id,
  :deployment_id,
  :deployment_name,
  :deployment_status,
  :iot_job_id,
  :iot_job_arn,
  :components,
  :deployment_policies,
  :iot_job_configuration,
  :creation_timestamp,
  :is_latest_for_target,
  :tags)
  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.



1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
# File 'gems/aws-sdk-greengrassv2/lib/aws-sdk-greengrassv2/types.rb', line 1790

class GetDeploymentResponse < Struct.new(
  :target_arn,
  :revision_id,
  :deployment_id,
  :deployment_name,
  :deployment_status,
  :iot_job_id,
  :iot_job_arn,
  :components,
  :deployment_policies,
  :iot_job_configuration,
  :creation_timestamp,
  :is_latest_for_target,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#deployment_statusString

The status of the deployment.

Returns:

  • (String)


1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
# File 'gems/aws-sdk-greengrassv2/lib/aws-sdk-greengrassv2/types.rb', line 1790

class GetDeploymentResponse < Struct.new(
  :target_arn,
  :revision_id,
  :deployment_id,
  :deployment_name,
  :deployment_status,
  :iot_job_id,
  :iot_job_arn,
  :components,
  :deployment_policies,
  :iot_job_configuration,
  :creation_timestamp,
  :is_latest_for_target,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#iot_job_arnString

The ARN of the AWS IoT job that applies the deployment to target devices.

Returns:

  • (String)


1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
# File 'gems/aws-sdk-greengrassv2/lib/aws-sdk-greengrassv2/types.rb', line 1790

class GetDeploymentResponse < Struct.new(
  :target_arn,
  :revision_id,
  :deployment_id,
  :deployment_name,
  :deployment_status,
  :iot_job_id,
  :iot_job_arn,
  :components,
  :deployment_policies,
  :iot_job_configuration,
  :creation_timestamp,
  :is_latest_for_target,
  :tags)
  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.



1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
# File 'gems/aws-sdk-greengrassv2/lib/aws-sdk-greengrassv2/types.rb', line 1790

class GetDeploymentResponse < Struct.new(
  :target_arn,
  :revision_id,
  :deployment_id,
  :deployment_name,
  :deployment_status,
  :iot_job_id,
  :iot_job_arn,
  :components,
  :deployment_policies,
  :iot_job_configuration,
  :creation_timestamp,
  :is_latest_for_target,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#iot_job_idString

The ID of the AWS IoT job that applies the deployment to target devices.

Returns:

  • (String)


1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
# File 'gems/aws-sdk-greengrassv2/lib/aws-sdk-greengrassv2/types.rb', line 1790

class GetDeploymentResponse < Struct.new(
  :target_arn,
  :revision_id,
  :deployment_id,
  :deployment_name,
  :deployment_status,
  :iot_job_id,
  :iot_job_arn,
  :components,
  :deployment_policies,
  :iot_job_configuration,
  :creation_timestamp,
  :is_latest_for_target,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#is_latest_for_targetBoolean

Whether or not the deployment is the latest revision for its target.

Returns:

  • (Boolean)


1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
# File 'gems/aws-sdk-greengrassv2/lib/aws-sdk-greengrassv2/types.rb', line 1790

class GetDeploymentResponse < Struct.new(
  :target_arn,
  :revision_id,
  :deployment_id,
  :deployment_name,
  :deployment_status,
  :iot_job_id,
  :iot_job_arn,
  :components,
  :deployment_policies,
  :iot_job_configuration,
  :creation_timestamp,
  :is_latest_for_target,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#revision_idString

The revision number of the deployment.

Returns:

  • (String)


1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
# File 'gems/aws-sdk-greengrassv2/lib/aws-sdk-greengrassv2/types.rb', line 1790

class GetDeploymentResponse < Struct.new(
  :target_arn,
  :revision_id,
  :deployment_id,
  :deployment_name,
  :deployment_status,
  :iot_job_id,
  :iot_job_arn,
  :components,
  :deployment_policies,
  :iot_job_configuration,
  :creation_timestamp,
  :is_latest_for_target,
  :tags)
  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 AWS IoT Greengrass V2 Developer Guide.

Returns:

  • (Hash<String,String>)


1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
# File 'gems/aws-sdk-greengrassv2/lib/aws-sdk-greengrassv2/types.rb', line 1790

class GetDeploymentResponse < Struct.new(
  :target_arn,
  :revision_id,
  :deployment_id,
  :deployment_name,
  :deployment_status,
  :iot_job_id,
  :iot_job_arn,
  :components,
  :deployment_policies,
  :iot_job_configuration,
  :creation_timestamp,
  :is_latest_for_target,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#target_arnString

The ARN of the target AWS IoT thing or thing group.

Returns:

  • (String)


1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
# File 'gems/aws-sdk-greengrassv2/lib/aws-sdk-greengrassv2/types.rb', line 1790

class GetDeploymentResponse < Struct.new(
  :target_arn,
  :revision_id,
  :deployment_id,
  :deployment_name,
  :deployment_status,
  :iot_job_id,
  :iot_job_arn,
  :components,
  :deployment_policies,
  :iot_job_configuration,
  :creation_timestamp,
  :is_latest_for_target,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end