Class: Aws::Proton::Types::CreateComponentInput
- Inherits:
-
Struct
- Object
- Struct
- Aws::Proton::Types::CreateComponentInput
- Defined in:
- gems/aws-sdk-proton/lib/aws-sdk-proton/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[:description, :manifest, :service_spec, :template_file]
Instance Attribute Summary collapse
-
#client_token ⇒ String
The client token for the created component.
-
#description ⇒ String
An optional customer-provided description of the component.
-
#environment_name ⇒ String
The name of the Proton environment that you want to associate this component with.
-
#manifest ⇒ String
A path to a manifest file that lists the Infrastructure as Code (IaC) file, template language, and rendering engine for infrastructure that a custom component provisions.
-
#name ⇒ String
The customer-provided name of the component.
-
#service_instance_name ⇒ String
The name of the service instance that you want to attach this component to.
-
#service_name ⇒ String
The name of the service that
serviceInstanceName
is associated with. -
#service_spec ⇒ String
The service spec that you want the component to use to access service inputs.
-
#tags ⇒ Array<Types::Tag>
An optional list of metadata items that you can associate with the Proton component.
-
#template_file ⇒ String
A path to the Infrastructure as Code (IaC) file describing infrastructure that a custom component provisions.
Instance Attribute Details
#client_token ⇒ String
The client token for the created component.
A suitable default value is auto-generated. You should normally not need to pass this option.
587 588 589 590 591 592 593 594 595 596 597 598 599 600 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/types.rb', line 587 class CreateComponentInput < Struct.new( :client_token, :description, :environment_name, :manifest, :name, :service_instance_name, :service_name, :service_spec, :tags, :template_file) SENSITIVE = [:description, :manifest, :service_spec, :template_file] include Aws::Structure end |
#description ⇒ String
An optional customer-provided description of the component.
587 588 589 590 591 592 593 594 595 596 597 598 599 600 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/types.rb', line 587 class CreateComponentInput < Struct.new( :client_token, :description, :environment_name, :manifest, :name, :service_instance_name, :service_name, :service_spec, :tags, :template_file) SENSITIVE = [:description, :manifest, :service_spec, :template_file] include Aws::Structure end |
#environment_name ⇒ String
The name of the Proton environment that you want to associate this
component with. You must specify this when you don't specify
serviceInstanceName
and serviceName
.
587 588 589 590 591 592 593 594 595 596 597 598 599 600 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/types.rb', line 587 class CreateComponentInput < Struct.new( :client_token, :description, :environment_name, :manifest, :name, :service_instance_name, :service_name, :service_spec, :tags, :template_file) SENSITIVE = [:description, :manifest, :service_spec, :template_file] include Aws::Structure end |
#manifest ⇒ String
A path to a manifest file that lists the Infrastructure as Code (IaC) file, template language, and rendering engine for infrastructure that a custom component provisions.
587 588 589 590 591 592 593 594 595 596 597 598 599 600 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/types.rb', line 587 class CreateComponentInput < Struct.new( :client_token, :description, :environment_name, :manifest, :name, :service_instance_name, :service_name, :service_spec, :tags, :template_file) SENSITIVE = [:description, :manifest, :service_spec, :template_file] include Aws::Structure end |
#name ⇒ String
The customer-provided name of the component.
587 588 589 590 591 592 593 594 595 596 597 598 599 600 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/types.rb', line 587 class CreateComponentInput < Struct.new( :client_token, :description, :environment_name, :manifest, :name, :service_instance_name, :service_name, :service_spec, :tags, :template_file) SENSITIVE = [:description, :manifest, :service_spec, :template_file] include Aws::Structure end |
#service_instance_name ⇒ String
The name of the service instance that you want to attach this
component to. If you don't specify this, the component isn't
attached to any service instance. Specify both serviceInstanceName
and serviceName
or neither of them.
587 588 589 590 591 592 593 594 595 596 597 598 599 600 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/types.rb', line 587 class CreateComponentInput < Struct.new( :client_token, :description, :environment_name, :manifest, :name, :service_instance_name, :service_name, :service_spec, :tags, :template_file) SENSITIVE = [:description, :manifest, :service_spec, :template_file] include Aws::Structure end |
#service_name ⇒ String
The name of the service that serviceInstanceName
is associated
with. If you don't specify this, the component isn't attached to
any service instance. Specify both serviceInstanceName
and
serviceName
or neither of them.
587 588 589 590 591 592 593 594 595 596 597 598 599 600 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/types.rb', line 587 class CreateComponentInput < Struct.new( :client_token, :description, :environment_name, :manifest, :name, :service_instance_name, :service_name, :service_spec, :tags, :template_file) SENSITIVE = [:description, :manifest, :service_spec, :template_file] include Aws::Structure end |
#service_spec ⇒ String
The service spec that you want the component to use to access service inputs. Set this only when you attach the component to a service instance.
587 588 589 590 591 592 593 594 595 596 597 598 599 600 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/types.rb', line 587 class CreateComponentInput < Struct.new( :client_token, :description, :environment_name, :manifest, :name, :service_instance_name, :service_name, :service_spec, :tags, :template_file) SENSITIVE = [:description, :manifest, :service_spec, :template_file] include Aws::Structure end |
#tags ⇒ Array<Types::Tag>
An optional list of metadata items that you can associate with the Proton component. A tag is a key-value pair.
For more information, see Proton resources and tagging in the Proton User Guide.
587 588 589 590 591 592 593 594 595 596 597 598 599 600 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/types.rb', line 587 class CreateComponentInput < Struct.new( :client_token, :description, :environment_name, :manifest, :name, :service_instance_name, :service_name, :service_spec, :tags, :template_file) SENSITIVE = [:description, :manifest, :service_spec, :template_file] include Aws::Structure end |
#template_file ⇒ String
A path to the Infrastructure as Code (IaC) file describing infrastructure that a custom component provisions.
587 588 589 590 591 592 593 594 595 596 597 598 599 600 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/types.rb', line 587 class CreateComponentInput < Struct.new( :client_token, :description, :environment_name, :manifest, :name, :service_instance_name, :service_name, :service_spec, :tags, :template_file) SENSITIVE = [:description, :manifest, :service_spec, :template_file] include Aws::Structure end |