Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1484319348.7 KB

Create an Proton component. A component is an infrastructure extension for a service instance.

For more information about components, see Proton components in the Proton User Guide.

post/#X-Amz-Target=AwsProton20200720.CreateComponent

Headers

X-Amz-Target'AwsProton20200720.CreateComponent' required

Request body

clientTokenstring

The client token for the created component.

descriptionstring password

An optional customer-provided description of the component.

environmentNamestring

The name of the Proton environment that you want to associate this component with. You must specify this when you don't specify <code>serviceInstanceName</code> and <code>serviceName</code>.

manifeststring password required

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.

namestring required

The customer-provided name of the component.

serviceInstanceNamestring

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 <code>serviceInstanceName</code> and <code>serviceName</code> or neither of them.

serviceNamestring

The name of the service that <code>serviceInstanceName</code> is associated with. If you don't specify this, the component isn't attached to any service instance. Specify both <code>serviceInstanceName</code> and <code>serviceName</code> or neither of them.

serviceSpecstring password

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.

templateFilestring password required
<p>A path to the Infrastructure as Code (IaC) file describing infrastructure that a custom component provisions.</p> <note> <p>Components support a single IaC file, even if you use Terraform as your template language.</p> </note>

Response

Success