Struct aws_sdk_lambda::input::add_permission_input::Builder

pub struct Builder { /* private fields */ }

A builder for AddPermissionInput.

Implementations

impl Builder

pub fn function_name(self, input: impl Into<String>) -> Self

The name of the Lambda function, version, or alias.

Name formats

• Function name - my-function (name-only), my-function:v1 (with alias).

• Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.

• Partial ARN - 123456789012:function:my-function.

You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

Examples found in repository

src/client.rs (line 1525)

        pub fn function_name(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.function_name(input.into());
            self
        }

pub fn set_function_name(self, input: Option<String>) -> Self

The name of the Lambda function, version, or alias.

Name formats

• Function name - my-function (name-only), my-function:v1 (with alias).

• Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.

• Partial ARN - 123456789012:function:my-function.

You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

Examples found in repository

src/client.rs (line 1540)

        pub fn set_function_name(
            mut self,
            input: std::option::Option<std::string::String>,
        ) -> Self {
            self.inner = self.inner.set_function_name(input);
            self
        }

pub fn statement_id(self, input: impl Into<String>) -> Self

A statement identifier that differentiates the statement from others in the same policy.

Examples found in repository

src/client.rs (line 1545)

        pub fn statement_id(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.statement_id(input.into());
            self
        }

pub fn set_statement_id(self, input: Option<String>) -> Self

A statement identifier that differentiates the statement from others in the same policy.

Examples found in repository

src/client.rs (line 1550)

        pub fn set_statement_id(mut self, input: std::option::Option<std::string::String>) -> Self {
            self.inner = self.inner.set_statement_id(input);
            self
        }

pub fn action(self, input: impl Into<String>) -> Self

The action that the principal can use on the function. For example, lambda:InvokeFunction or lambda:GetFunction.

Examples found in repository

src/client.rs (line 1555)

        pub fn action(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.action(input.into());
            self
        }

pub fn set_action(self, input: Option<String>) -> Self

The action that the principal can use on the function. For example, lambda:InvokeFunction or lambda:GetFunction.

Examples found in repository

src/client.rs (line 1560)

        pub fn set_action(mut self, input: std::option::Option<std::string::String>) -> Self {
            self.inner = self.inner.set_action(input);
            self
        }

pub fn principal(self, input: impl Into<String>) -> Self

The Amazon Web Services service or account that invokes the function. If you specify a service, use SourceArn or SourceAccount to limit who can invoke the function through that service.

Examples found in repository

src/client.rs (line 1565)

        pub fn principal(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.principal(input.into());
            self
        }

pub fn set_principal(self, input: Option<String>) -> Self

The Amazon Web Services service or account that invokes the function. If you specify a service, use SourceArn or SourceAccount to limit who can invoke the function through that service.

Examples found in repository

src/client.rs (line 1570)

        pub fn set_principal(mut self, input: std::option::Option<std::string::String>) -> Self {
            self.inner = self.inner.set_principal(input);
            self
        }

pub fn source_arn(self, input: impl Into<String>) -> Self

For Amazon Web Services services, the ARN of the Amazon Web Services resource that invokes the function. For example, an Amazon S3 bucket or Amazon SNS topic.

Note that Lambda configures the comparison using the StringLike operator.

Examples found in repository

src/client.rs (line 1576)

        pub fn source_arn(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.source_arn(input.into());
            self
        }

pub fn set_source_arn(self, input: Option<String>) -> Self

For Amazon Web Services services, the ARN of the Amazon Web Services resource that invokes the function. For example, an Amazon S3 bucket or Amazon SNS topic.

Note that Lambda configures the comparison using the StringLike operator.

Examples found in repository

src/client.rs (line 1582)

        pub fn set_source_arn(mut self, input: std::option::Option<std::string::String>) -> Self {
            self.inner = self.inner.set_source_arn(input);
            self
        }

pub fn source_account(self, input: impl Into<String>) -> Self

For Amazon S3, the ID of the account that owns the resource. Use this together with SourceArn to ensure that the resource is owned by the specified account. It is possible for an Amazon S3 bucket to be deleted by its owner and recreated by another account.

Examples found in repository

src/client.rs (line 1587)

        pub fn source_account(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.source_account(input.into());
            self
        }

pub fn set_source_account(self, input: Option<String>) -> Self

For Amazon S3, the ID of the account that owns the resource. Use this together with SourceArn to ensure that the resource is owned by the specified account. It is possible for an Amazon S3 bucket to be deleted by its owner and recreated by another account.

Examples found in repository

src/client.rs (line 1595)

        pub fn set_source_account(
            mut self,
            input: std::option::Option<std::string::String>,
        ) -> Self {
            self.inner = self.inner.set_source_account(input);
            self
        }

pub fn event_source_token(self, input: impl Into<String>) -> Self

For Alexa Smart Home functions, a token that must be supplied by the invoker.

Examples found in repository

src/client.rs (line 1600)

        pub fn event_source_token(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.event_source_token(input.into());
            self
        }

pub fn set_event_source_token(self, input: Option<String>) -> Self

For Alexa Smart Home functions, a token that must be supplied by the invoker.

Examples found in repository

src/client.rs (line 1608)

        pub fn set_event_source_token(
            mut self,
            input: std::option::Option<std::string::String>,
        ) -> Self {
            self.inner = self.inner.set_event_source_token(input);
            self
        }

pub fn qualifier(self, input: impl Into<String>) -> Self

Specify a version or alias to add permissions to a published version of the function.

Examples found in repository

src/client.rs (line 1613)

        pub fn qualifier(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.qualifier(input.into());
            self
        }

pub fn set_qualifier(self, input: Option<String>) -> Self

Specify a version or alias to add permissions to a published version of the function.

Examples found in repository

src/client.rs (line 1618)

        pub fn set_qualifier(mut self, input: std::option::Option<std::string::String>) -> Self {
            self.inner = self.inner.set_qualifier(input);
            self
        }

pub fn revision_id(self, input: impl Into<String>) -> Self

Only update the policy if the revision ID matches the ID that's specified. Use this option to avoid modifying a policy that has changed since you last read it.

Examples found in repository

src/client.rs (line 1623)

        pub fn revision_id(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.revision_id(input.into());
            self
        }

pub fn set_revision_id(self, input: Option<String>) -> Self

Only update the policy if the revision ID matches the ID that's specified. Use this option to avoid modifying a policy that has changed since you last read it.

Examples found in repository

src/client.rs (line 1628)

        pub fn set_revision_id(mut self, input: std::option::Option<std::string::String>) -> Self {
            self.inner = self.inner.set_revision_id(input);
            self
        }

pub fn principal_org_id(self, input: impl Into<String>) -> Self

The identifier for your organization in Organizations. Use this to grant permissions to all the Amazon Web Services accounts under this organization.

Examples found in repository

src/client.rs (line 1633)

        pub fn principal_org_id(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.principal_org_id(input.into());
            self
        }

pub fn set_principal_org_id(self, input: Option<String>) -> Self

The identifier for your organization in Organizations. Use this to grant permissions to all the Amazon Web Services accounts under this organization.

Examples found in repository

src/client.rs (line 1641)

        pub fn set_principal_org_id(
            mut self,
            input: std::option::Option<std::string::String>,
        ) -> Self {
            self.inner = self.inner.set_principal_org_id(input);
            self
        }

pub fn function_url_auth_type(self, input: FunctionUrlAuthType) -> Self

The type of authentication that your function URL uses. Set to AWS_IAM if you want to restrict access to authenticated IAM users only. Set to NONE if you want to bypass IAM authentication to create a public endpoint. For more information, see Security and auth model for Lambda function URLs.

Examples found in repository

src/client.rs (line 1646)

        pub fn function_url_auth_type(mut self, input: crate::model::FunctionUrlAuthType) -> Self {
            self.inner = self.inner.function_url_auth_type(input);
            self
        }

pub fn set_function_url_auth_type(
    self,
    input: Option<FunctionUrlAuthType>
) -> Self

The type of authentication that your function URL uses. Set to AWS_IAM if you want to restrict access to authenticated IAM users only. Set to NONE if you want to bypass IAM authentication to create a public endpoint. For more information, see Security and auth model for Lambda function URLs.

Examples found in repository

src/client.rs (line 1654)

        pub fn set_function_url_auth_type(
            mut self,
            input: std::option::Option<crate::model::FunctionUrlAuthType>,
        ) -> Self {
            self.inner = self.inner.set_function_url_auth_type(input);
            self
        }

pub fn build(self) -> Result<AddPermissionInput, BuildError>

Consumes the builder and constructs a AddPermissionInput.

Examples found in repository

src/client.rs (line 1485)

        pub async fn customize(
            self,
        ) -> std::result::Result<
            crate::operation::customize::CustomizableOperation<
                crate::operation::AddPermission,
                aws_http::retry::AwsResponseRetryClassifier,
            >,
            aws_smithy_http::result::SdkError<crate::error::AddPermissionError>,
        > {
            let handle = self.handle.clone();
            let operation = self
                .inner
                .build()
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?
                .make_operation(&handle.conf)
                .await
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?;
            Ok(crate::operation::customize::CustomizableOperation { handle, operation })
        }

        /// Sends the request and returns the response.
        ///
        /// If an error occurs, an `SdkError` will be returned with additional details that
        /// can be matched against.
        ///
        /// By default, any retryable failures will be retried twice. Retry behavior
        /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
        /// set when configuring the client.
        pub async fn send(
            self,
        ) -> std::result::Result<
            crate::output::AddPermissionOutput,
            aws_smithy_http::result::SdkError<crate::error::AddPermissionError>,
        > {
            let op = self
                .inner
                .build()
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?
                .make_operation(&self.handle.conf)
                .await
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?;
            self.handle.client.call(op).await
        }

Trait Implementations

impl Clone for Builder

fn clone(&self) -> Builder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Builder

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

Formats the value using the given formatter.

impl Default for Builder

fn default() -> Builder

Returns the “default value” for a type.

impl PartialEq<Builder> for Builder

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for Builder