Class: Aws::SupplyChain::Types::Instance

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

Overview

The details of the instance.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#aws_account_idString

The Amazon Web Services account ID that owns the instance.

Returns:

  • (String)


994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
# File 'gems/aws-sdk-supplychain/lib/aws-sdk-supplychain/types.rb', line 994

class Instance < Struct.new(
  :instance_id,
  :aws_account_id,
  :state,
  :error_message,
  :web_app_dns_domain,
  :created_time,
  :last_modified_time,
  :instance_name,
  :instance_description,
  :kms_key_arn,
  :version_number)
  SENSITIVE = []
  include Aws::Structure
end

#created_timeTime

The instance creation timestamp.

Returns:

  • (Time)


994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
# File 'gems/aws-sdk-supplychain/lib/aws-sdk-supplychain/types.rb', line 994

class Instance < Struct.new(
  :instance_id,
  :aws_account_id,
  :state,
  :error_message,
  :web_app_dns_domain,
  :created_time,
  :last_modified_time,
  :instance_name,
  :instance_description,
  :kms_key_arn,
  :version_number)
  SENSITIVE = []
  include Aws::Structure
end

#error_messageString

The Amazon Web Services Supply Chain instance error message. If the instance results in an unhealthy state, customers need to check the error message, delete the current instance, and recreate a new one based on the mitigation from the error message.

Returns:

  • (String)


994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
# File 'gems/aws-sdk-supplychain/lib/aws-sdk-supplychain/types.rb', line 994

class Instance < Struct.new(
  :instance_id,
  :aws_account_id,
  :state,
  :error_message,
  :web_app_dns_domain,
  :created_time,
  :last_modified_time,
  :instance_name,
  :instance_description,
  :kms_key_arn,
  :version_number)
  SENSITIVE = []
  include Aws::Structure
end

#instance_descriptionString

The Amazon Web Services Supply Chain instance description.

Returns:

  • (String)


994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
# File 'gems/aws-sdk-supplychain/lib/aws-sdk-supplychain/types.rb', line 994

class Instance < Struct.new(
  :instance_id,
  :aws_account_id,
  :state,
  :error_message,
  :web_app_dns_domain,
  :created_time,
  :last_modified_time,
  :instance_name,
  :instance_description,
  :kms_key_arn,
  :version_number)
  SENSITIVE = []
  include Aws::Structure
end

#instance_idString

The Amazon Web Services Supply Chain instance identifier.

Returns:

  • (String)


994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
# File 'gems/aws-sdk-supplychain/lib/aws-sdk-supplychain/types.rb', line 994

class Instance < Struct.new(
  :instance_id,
  :aws_account_id,
  :state,
  :error_message,
  :web_app_dns_domain,
  :created_time,
  :last_modified_time,
  :instance_name,
  :instance_description,
  :kms_key_arn,
  :version_number)
  SENSITIVE = []
  include Aws::Structure
end

#instance_nameString

The Amazon Web Services Supply Chain instance name.

Returns:

  • (String)


994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
# File 'gems/aws-sdk-supplychain/lib/aws-sdk-supplychain/types.rb', line 994

class Instance < Struct.new(
  :instance_id,
  :aws_account_id,
  :state,
  :error_message,
  :web_app_dns_domain,
  :created_time,
  :last_modified_time,
  :instance_name,
  :instance_description,
  :kms_key_arn,
  :version_number)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_arnString

The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you optionally provided for encryption. If you did not provide anything here, AWS Supply Chain uses the Amazon Web Services owned KMS key and nothing is returned.

Returns:

  • (String)


994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
# File 'gems/aws-sdk-supplychain/lib/aws-sdk-supplychain/types.rb', line 994

class Instance < Struct.new(
  :instance_id,
  :aws_account_id,
  :state,
  :error_message,
  :web_app_dns_domain,
  :created_time,
  :last_modified_time,
  :instance_name,
  :instance_description,
  :kms_key_arn,
  :version_number)
  SENSITIVE = []
  include Aws::Structure
end

#last_modified_timeTime

The instance last modified timestamp.

Returns:

  • (Time)


994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
# File 'gems/aws-sdk-supplychain/lib/aws-sdk-supplychain/types.rb', line 994

class Instance < Struct.new(
  :instance_id,
  :aws_account_id,
  :state,
  :error_message,
  :web_app_dns_domain,
  :created_time,
  :last_modified_time,
  :instance_name,
  :instance_description,
  :kms_key_arn,
  :version_number)
  SENSITIVE = []
  include Aws::Structure
end

#stateString

The state of the instance.

Returns:

  • (String)


994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
# File 'gems/aws-sdk-supplychain/lib/aws-sdk-supplychain/types.rb', line 994

class Instance < Struct.new(
  :instance_id,
  :aws_account_id,
  :state,
  :error_message,
  :web_app_dns_domain,
  :created_time,
  :last_modified_time,
  :instance_name,
  :instance_description,
  :kms_key_arn,
  :version_number)
  SENSITIVE = []
  include Aws::Structure
end

#version_numberFloat

The version number of the instance.

Returns:

  • (Float)


994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
# File 'gems/aws-sdk-supplychain/lib/aws-sdk-supplychain/types.rb', line 994

class Instance < Struct.new(
  :instance_id,
  :aws_account_id,
  :state,
  :error_message,
  :web_app_dns_domain,
  :created_time,
  :last_modified_time,
  :instance_name,
  :instance_description,
  :kms_key_arn,
  :version_number)
  SENSITIVE = []
  include Aws::Structure
end

#web_app_dns_domainString

The WebApp DNS domain name of the instance.

Returns:

  • (String)


994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
# File 'gems/aws-sdk-supplychain/lib/aws-sdk-supplychain/types.rb', line 994

class Instance < Struct.new(
  :instance_id,
  :aws_account_id,
  :state,
  :error_message,
  :web_app_dns_domain,
  :created_time,
  :last_modified_time,
  :instance_name,
  :instance_description,
  :kms_key_arn,
  :version_number)
  SENSITIVE = []
  include Aws::Structure
end