aws_sdk_s3outposts/client/
create_endpoint.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`CreateEndpoint`](crate::operation::create_endpoint::builders::CreateEndpointFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`outpost_id(impl Into<String>)`](crate::operation::create_endpoint::builders::CreateEndpointFluentBuilder::outpost_id) / [`set_outpost_id(Option<String>)`](crate::operation::create_endpoint::builders::CreateEndpointFluentBuilder::set_outpost_id):<br>required: **true**<br><p>The ID of the Outposts.</p><br>
    ///   - [`subnet_id(impl Into<String>)`](crate::operation::create_endpoint::builders::CreateEndpointFluentBuilder::subnet_id) / [`set_subnet_id(Option<String>)`](crate::operation::create_endpoint::builders::CreateEndpointFluentBuilder::set_subnet_id):<br>required: **true**<br><p>The ID of the subnet in the selected VPC. The endpoint subnet must belong to the Outpost that has Amazon S3 on Outposts provisioned.</p><br>
    ///   - [`security_group_id(impl Into<String>)`](crate::operation::create_endpoint::builders::CreateEndpointFluentBuilder::security_group_id) / [`set_security_group_id(Option<String>)`](crate::operation::create_endpoint::builders::CreateEndpointFluentBuilder::set_security_group_id):<br>required: **true**<br><p>The ID of the security group to use with the endpoint.</p><br>
    ///   - [`access_type(EndpointAccessType)`](crate::operation::create_endpoint::builders::CreateEndpointFluentBuilder::access_type) / [`set_access_type(Option<EndpointAccessType>)`](crate::operation::create_endpoint::builders::CreateEndpointFluentBuilder::set_access_type):<br>required: **false**<br><p>The type of access for the network connectivity for the Amazon S3 on Outposts endpoint. To use the Amazon Web Services VPC, choose <code>Private</code>. To use the endpoint with an on-premises network, choose <code>CustomerOwnedIp</code>. If you choose <code>CustomerOwnedIp</code>, you must also provide the customer-owned IP address pool (CoIP pool).</p><note>  <p><code>Private</code> is the default access type value.</p> </note><br>
    ///   - [`customer_owned_ipv4_pool(impl Into<String>)`](crate::operation::create_endpoint::builders::CreateEndpointFluentBuilder::customer_owned_ipv4_pool) / [`set_customer_owned_ipv4_pool(Option<String>)`](crate::operation::create_endpoint::builders::CreateEndpointFluentBuilder::set_customer_owned_ipv4_pool):<br>required: **false**<br><p>The ID of the customer-owned IPv4 address pool (CoIP pool) for the endpoint. IP addresses are allocated from this pool for the endpoint.</p><br>
    /// - On success, responds with [`CreateEndpointOutput`](crate::operation::create_endpoint::CreateEndpointOutput) with field(s):
    ///   - [`endpoint_arn(Option<String>)`](crate::operation::create_endpoint::CreateEndpointOutput::endpoint_arn): <p>The Amazon Resource Name (ARN) of the endpoint.</p>
    /// - On failure, responds with [`SdkError<CreateEndpointError>`](crate::operation::create_endpoint::CreateEndpointError)
    pub fn create_endpoint(&self) -> crate::operation::create_endpoint::builders::CreateEndpointFluentBuilder {
        crate::operation::create_endpoint::builders::CreateEndpointFluentBuilder::new(self.handle.clone())
    }
}