aws_sdk_evs/client/

create_environment_connector.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`CreateEnvironmentConnector`](crate::operation::create_environment_connector::builders::CreateEnvironmentConnectorFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`client_token(impl Into<String>)`](crate::operation::create_environment_connector::builders::CreateEnvironmentConnectorFluentBuilder::client_token) / [`set_client_token(Option<String>)`](crate::operation::create_environment_connector::builders::CreateEnvironmentConnectorFluentBuilder::set_client_token):<br>required: **false**<br><note>  <p>This parameter is not used in Amazon EVS currently. If you supply input for this parameter, it will have no effect.</p> </note> <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the connector creation request. If you do not specify a client token, a randomly generated token is used for the request to ensure idempotency.</p><br>
    ///   - [`environment_id(impl Into<String>)`](crate::operation::create_environment_connector::builders::CreateEnvironmentConnectorFluentBuilder::environment_id) / [`set_environment_id(Option<String>)`](crate::operation::create_environment_connector::builders::CreateEnvironmentConnectorFluentBuilder::set_environment_id):<br>required: **true**<br><p>A unique ID for the environment to create the connector in.</p><br>
    ///   - [`r#type(ConnectorType)`](crate::operation::create_environment_connector::builders::CreateEnvironmentConnectorFluentBuilder::type) / [`set_type(Option<ConnectorType>)`](crate::operation::create_environment_connector::builders::CreateEnvironmentConnectorFluentBuilder::set_type):<br>required: **true**<br><p>The type of connector to create.</p> <ul>  <li>   <p><code>OPERATIONS_MANAGER</code>: Connector to an Operations Manager appliance. Required for VCF 9x environments.</p></li>  <li>   <p><code>SDDC_MANAGER</code>: Connector to an SDDC Manager appliance. Required for VCF 5.x environments.</p></li>  <li>   <p><code>VCENTER</code>: Connector to a vCenter Server appliance. Required for features that depend on vCenter, such as Windows Server license-included.</p></li> </ul><br>
    ///   - [`appliance_fqdn(impl Into<String>)`](crate::operation::create_environment_connector::builders::CreateEnvironmentConnectorFluentBuilder::appliance_fqdn) / [`set_appliance_fqdn(Option<String>)`](crate::operation::create_environment_connector::builders::CreateEnvironmentConnectorFluentBuilder::set_appliance_fqdn):<br>required: **true**<br><p>The fully qualified domain name (FQDN) of the VCF appliance that the connector targets.</p><br>
    ///   - [`secret_identifier(impl Into<String>)`](crate::operation::create_environment_connector::builders::CreateEnvironmentConnectorFluentBuilder::secret_identifier) / [`set_secret_identifier(Option<String>)`](crate::operation::create_environment_connector::builders::CreateEnvironmentConnectorFluentBuilder::set_secret_identifier):<br>required: **true**<br><p>The ARN or name of the Amazon Web Services Secrets Manager secret that stores the credentials for the VCF appliance. <code>SDDC_MANAGER</code> requires an <code>apiKey</code> field; <code>OPERATIONS_MANAGER</code> and <code>VCENTER</code> require <code>username</code> and <code>password</code> fields.</p><important>  <p>Do not use credentials with Administrator privileges. We recommend using a service account with read-only permissions.</p> </important><br>
    /// - On success, responds with [`CreateEnvironmentConnectorOutput`](crate::operation::create_environment_connector::CreateEnvironmentConnectorOutput) with field(s):
    ///   - [`connector(Option<Connector>)`](crate::operation::create_environment_connector::CreateEnvironmentConnectorOutput::connector): <p>A description of the created connector.</p>
    /// - On failure, responds with [`SdkError<CreateEnvironmentConnectorError>`](crate::operation::create_environment_connector::CreateEnvironmentConnectorError)
    pub fn create_environment_connector(&self) -> crate::operation::create_environment_connector::builders::CreateEnvironmentConnectorFluentBuilder {
        crate::operation::create_environment_connector::builders::CreateEnvironmentConnectorFluentBuilder::new(self.handle.clone())
    }
}