aws_sdk_globalaccelerator/client/

create_accelerator.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`CreateAccelerator`](crate::operation::create_accelerator::builders::CreateAcceleratorFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`name(impl Into<String>)`](crate::operation::create_accelerator::builders::CreateAcceleratorFluentBuilder::name) / [`set_name(Option<String>)`](crate::operation::create_accelerator::builders::CreateAcceleratorFluentBuilder::set_name):<br>required: **true**<br><p>The name of the accelerator. The name can have a maximum of 64 characters, must contain only alphanumeric characters, periods (.), or hyphens (-), and must not begin or end with a hyphen or period.</p><br>
    ///   - [`ip_address_type(IpAddressType)`](crate::operation::create_accelerator::builders::CreateAcceleratorFluentBuilder::ip_address_type) / [`set_ip_address_type(Option<IpAddressType>)`](crate::operation::create_accelerator::builders::CreateAcceleratorFluentBuilder::set_ip_address_type):<br>required: **false**<br><p>The IP address type that an accelerator supports. For a standard accelerator, the value can be IPV4 or DUAL_STACK.</p><br>
    ///   - [`ip_addresses(impl Into<String>)`](crate::operation::create_accelerator::builders::CreateAcceleratorFluentBuilder::ip_addresses) / [`set_ip_addresses(Option<Vec::<String>>)`](crate::operation::create_accelerator::builders::CreateAcceleratorFluentBuilder::set_ip_addresses):<br>required: **false**<br><p>Optionally, if you've added your own IP address pool to Global Accelerator (BYOIP), you can choose an IPv4 address from your own pool to use for the accelerator's static IPv4 address when you create an accelerator.</p> <p>After you bring an address range to Amazon Web Services, it appears in your account as an address pool. When you create an accelerator, you can assign one IPv4 address from your range to it. Global Accelerator assigns you a second static IPv4 address from an Amazon IP address range. If you bring two IPv4 address ranges to Amazon Web Services, you can assign one IPv4 address from each range to your accelerator. This restriction is because Global Accelerator assigns each address range to a different network zone, for high availability.</p> <p>You can specify one or two addresses, separated by a space. Do not include the /32 suffix.</p> <p>Note that you can't update IP addresses for an existing accelerator. To change them, you must create a new accelerator with the new addresses.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html">Bring your own IP addresses (BYOIP)</a> in the <i>Global Accelerator Developer Guide</i>.</p><br>
    ///   - [`enabled(bool)`](crate::operation::create_accelerator::builders::CreateAcceleratorFluentBuilder::enabled) / [`set_enabled(Option<bool>)`](crate::operation::create_accelerator::builders::CreateAcceleratorFluentBuilder::set_enabled):<br>required: **false**<br><p>Indicates whether an accelerator is enabled. The value is true or false. The default value is true.</p> <p>If the value is set to true, an accelerator cannot be deleted. If set to false, the accelerator can be deleted.</p><br>
    ///   - [`idempotency_token(impl Into<String>)`](crate::operation::create_accelerator::builders::CreateAcceleratorFluentBuilder::idempotency_token) / [`set_idempotency_token(Option<String>)`](crate::operation::create_accelerator::builders::CreateAcceleratorFluentBuilder::set_idempotency_token):<br>required: **true**<br><p>A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of an accelerator.</p><br>
    ///   - [`tags(Tag)`](crate::operation::create_accelerator::builders::CreateAcceleratorFluentBuilder::tags) / [`set_tags(Option<Vec::<Tag>>)`](crate::operation::create_accelerator::builders::CreateAcceleratorFluentBuilder::set_tags):<br>required: **false**<br><p>Create tags for an accelerator.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/tagging-in-global-accelerator.html">Tagging in Global Accelerator</a> in the <i>Global Accelerator Developer Guide</i>.</p><br>
    /// - On success, responds with [`CreateAcceleratorOutput`](crate::operation::create_accelerator::CreateAcceleratorOutput) with field(s):
    ///   - [`accelerator(Option<Accelerator>)`](crate::operation::create_accelerator::CreateAcceleratorOutput::accelerator): <p>The accelerator that is created by specifying a listener and the supported IP address types.</p>
    /// - On failure, responds with [`SdkError<CreateAcceleratorError>`](crate::operation::create_accelerator::CreateAcceleratorError)
    pub fn create_accelerator(&self) -> crate::operation::create_accelerator::builders::CreateAcceleratorFluentBuilder {
        crate::operation::create_accelerator::builders::CreateAcceleratorFluentBuilder::new(self.handle.clone())
    }
}