Struct CreateComponentInput

#[non_exhaustive]
pub struct CreateComponentInput {
    pub name: Option<String>,
    pub description: Option<String>,
    pub service_name: Option<String>,
    pub service_instance_name: Option<String>,
    pub environment_name: Option<String>,
    pub template_file: Option<String>,
    pub manifest: Option<String>,
    pub service_spec: Option<String>,
    pub tags: Option<Vec<Tag>>,
    pub client_token: Option<String>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: Option<String>

The customer-provided name of the component.

description: Option<String>

An optional customer-provided description of the component.

service_name: Option<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.

service_instance_name: Option<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.

environment_name: Option<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.

template_file: Option<String>

A path to the Infrastructure as Code (IaC) file describing infrastructure that a custom component provisions.

Components support a single IaC file, even if you use Terraform as your template language.

manifest: Option<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.

service_spec: Option<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.

tags: Option<Vec<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.

client_token: Option<String>

The client token for the created component.

Implementations

impl CreateComponentInput

pub fn name(&self) -> Option<&str>

The customer-provided name of the component.

pub fn description(&self) -> Option<&str>

An optional customer-provided description of the component.

pub fn service_name(&self) -> Option<&str>

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.

pub fn service_instance_name(&self) -> Option<&str>

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.

pub fn environment_name(&self) -> Option<&str>

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.

pub fn template_file(&self) -> Option<&str>

A path to the Infrastructure as Code (IaC) file describing infrastructure that a custom component provisions.

Components support a single IaC file, even if you use Terraform as your template language.

pub fn manifest(&self) -> Option<&str>

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.

pub fn service_spec(&self) -> Option<&str>

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.

pub fn tags(&self) -> &[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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .tags.is_none().

pub fn client_token(&self) -> Option<&str>

The client token for the created component.

impl CreateComponentInput

pub fn builder() -> CreateComponentInputBuilder

Creates a new builder-style object to manufacture CreateComponentInput.

Trait Implementations

impl Clone for CreateComponentInput

fn clone(&self) -> CreateComponentInput

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateComponentInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for CreateComponentInput

fn eq(&self, other: &CreateComponentInput) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CreateComponentInput