Class: Aws::SupplyChain::Types::CreateInstanceRequest

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

Overview

The request parameters for CreateInstance.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_token ⇒ String

The client token for idempotency.

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

Returns:

  • (String) 


290
291
292
293
294
295
296
297
298
299
 
# File 'gems/aws-sdk-supplychain/lib/aws-sdk-supplychain/types.rb', line 290

class CreateInstanceRequest < Struct.new(
  :instance_name,
  :instance_description,
  :kms_key_arn,
  :web_app_dns_domain,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#instance_description ⇒ String

The AWS Supply Chain instance description.

Returns:

  • (String) 


290
291
292
293
294
295
296
297
298
299
 
# File 'gems/aws-sdk-supplychain/lib/aws-sdk-supplychain/types.rb', line 290

class CreateInstanceRequest < Struct.new(
  :instance_name,
  :instance_description,
  :kms_key_arn,
  :web_app_dns_domain,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#instance_name ⇒ String

The AWS Supply Chain instance name.

Returns:

  • (String) 


290
291
292
293
294
295
296
297
298
299
 
# File 'gems/aws-sdk-supplychain/lib/aws-sdk-supplychain/types.rb', line 290

class CreateInstanceRequest < Struct.new(
  :instance_name,
  :instance_description,
  :kms_key_arn,
  :web_app_dns_domain,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_arn ⇒ String

The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption. This is required if you do not want to use the Amazon Web Services owned KMS key. If you don't provide anything here, AWS Supply Chain uses the Amazon Web Services owned KMS key.

Returns:

  • (String) 


290
291
292
293
294
295
296
297
298
299
 
# File 'gems/aws-sdk-supplychain/lib/aws-sdk-supplychain/types.rb', line 290

class CreateInstanceRequest < Struct.new(
  :instance_name,
  :instance_description,
  :kms_key_arn,
  :web_app_dns_domain,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

The Amazon Web Services tags of an instance to be created.

Returns:

  • (Hash<String,String>) 


290
291
292
293
294
295
296
297
298
299
 
# File 'gems/aws-sdk-supplychain/lib/aws-sdk-supplychain/types.rb', line 290

class CreateInstanceRequest < Struct.new(
  :instance_name,
  :instance_description,
  :kms_key_arn,
  :web_app_dns_domain,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#web_app_dns_domain ⇒ String

The DNS subdomain of the web app. This would be "example" in the URL "example.scn.global.on.aws". You can set this to a custom value, as long as the domain isn't already being used by someone else. The name may only include alphanumeric characters and hyphens.

Returns:

  • (String) 


290
291
292
293
294
295
296
297
298
299
 
# File 'gems/aws-sdk-supplychain/lib/aws-sdk-supplychain/types.rb', line 290

class CreateInstanceRequest < Struct.new(
  :instance_name,
  :instance_description,
  :kms_key_arn,
  :web_app_dns_domain,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end