Struct AddPermissionFluentBuilder

pub struct AddPermissionFluentBuilder { /* private fields */ }

Fluent builder constructing a request to AddPermission.

Grants a principal permission to use a function. You can apply the policy at the function level, or specify a qualifier to restrict access to a single version or alias. If you use a qualifier, the invoker must use the full Amazon Resource Name (ARN) of that version or alias to invoke the function. Note: Lambda does not support adding policies to version $LATEST.

To grant permission to another account, specify the account ID as the Principal. To grant permission to an organization defined in Organizations, specify the organization ID as the PrincipalOrgID. For Amazon Web Services services, the principal is a domain-style identifier that the service defines, such as s3.amazonaws.com or sns.amazonaws.com. For Amazon Web Services services, you can also specify the ARN of the associated resource as the SourceArn. If you grant permission to a service principal without specifying the source, other accounts could potentially configure resources in their account to invoke your Lambda function.

This operation adds a statement to a resource-based permissions policy for the function. For more information about function policies, see Using resource-based policies for Lambda.

Implementations

impl AddPermissionFluentBuilder

pub fn as_input(&self) -> &AddPermissionInputBuilder

Access the AddPermission as a reference.

pub async fn send( self, ) -> Result<AddPermissionOutput, SdkError<AddPermissionError, HttpResponse>>

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, which can be set when configuring the client.

pub fn customize( self, ) -> CustomizableOperation<AddPermissionOutput, AddPermissionError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

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

The name or ARN 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.

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

The name or ARN 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.

pub fn get_function_name(&self) -> &Option<String>

The name or ARN 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.

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

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

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

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

pub fn get_statement_id(&self) -> &Option<String>

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

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.

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.

pub fn get_action(&self) -> &Option<String>

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

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

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

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

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

pub fn get_principal(&self) -> &Option<String>

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

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.

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.

pub fn get_source_arn(&self) -> &Option<String>

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.

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

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

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

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

pub fn get_source_account(&self) -> &Option<String>

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

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

For Alexa Smart Home functions, a token that the invoker must supply.

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

For Alexa Smart Home functions, a token that the invoker must supply.

pub fn get_event_source_token(&self) -> &Option<String>

For Alexa Smart Home functions, a token that the invoker must supply.

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

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

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

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

pub fn get_qualifier(&self) -> &Option<String>

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

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

Update the policy only 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.

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

Update the policy only 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.

pub fn get_revision_id(&self) -> &Option<String>

Update the policy only 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.

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.

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.

pub fn get_principal_org_id(&self) -> &Option<String>

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

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 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.

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 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.

pub fn get_function_url_auth_type(&self) -> &Option<FunctionUrlAuthType>

The type of authentication that your function URL uses. Set to AWS_IAM if you want to restrict access to authenticated 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.

Trait Implementations

impl Clone for AddPermissionFluentBuilder

fn clone(&self) -> AddPermissionFluentBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AddPermissionFluentBuilder

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

Formats the value using the given formatter.