Class: Ansible::Ruby::Modules::Lambda_policy

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/cloud/amazon/lambda_policy.rb

Overview

This module allows the management of AWS Lambda policy statements. It is idempotent and supports “Check” mode. Use module M(lambda) to manage the lambda function itself, M(lambda_alias) to manage function aliases, M(lambda_event) to manage event source mappings such as Kinesis streams, M(execute_lambda) to execute a lambda function and M(lambda_facts) to gather facts relating to one or more lambda functions.

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#action ⇒ Object

Returns The AWS Lambda action you want to allow in this statement. Each Lambda action is a string starting with lambda: followed by the API name (see Operations ). For example, lambda:CreateFunction . You can use wildcard (lambda:* ) to grant permission for all AWS Lambda actions.

Returns:

  • (Object) —

    The AWS Lambda action you want to allow in this statement. Each Lambda action is a string starting with lambda: followed by the API name (see Operations ). For example, lambda:CreateFunction . You can use wildcard (lambda:* ) to grant permission for all AWS Lambda actions.



30
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/lambda_policy.rb', line 30

attribute :action

#alias ⇒ Object?

Returns Name of the function alias. Mutually exclusive with C(version).

Returns:

  • (Object, nil) —

    Name of the function alias. Mutually exclusive with C(version).



20
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/lambda_policy.rb', line 20

attribute :alias

#event_source_token ⇒ Object?

Returns Token string representing source ARN or account. Mutually exclusive with C(source_arn) or C(source_account).

Returns:

  • (Object, nil) —

    Token string representing source ARN or account. Mutually exclusive with C(source_arn) or C(source_account).



44
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/lambda_policy.rb', line 44

attribute :event_source_token

#function_name ⇒ Object

Returns Name of the Lambda function whose resource policy you are updating by adding a new permission.,You can specify a function name (for example, Thumbnail ) or you can specify Amazon Resource Name (ARN) of the,function (for example, arn:aws:lambda:us-west-2:account-id:function:ThumbNail ). AWS Lambda also allows you to,specify partial ARN (for example, account-id:Thumbnail ). Note that the length constraint applies only to the,ARN. If you specify only the function name, it is limited to 64 character in length.

Returns:

  • (Object) —

    Name of the Lambda function whose resource policy you are updating by adding a new permission.,You can specify a function name (for example, Thumbnail ) or you can specify Amazon Resource Name (ARN) of the,function (for example, arn:aws:lambda:us-west-2:account-id:function:ThumbNail ). AWS Lambda also allows you to,specify partial ARN (for example, account-id:Thumbnail ). Note that the length constraint applies only to the,ARN. If you specify only the function name, it is limited to 64 character in length.



12
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/lambda_policy.rb', line 12

attribute :function_name

#principal ⇒ Object

Returns The principal who is getting this permission. It can be Amazon S3 service Principal (s3.amazonaws.com ) if you want Amazon S3 to invoke the function, an AWS account ID if you are granting cross-account permission, or any valid AWS service principal such as sns.amazonaws.com . For example, you might want to allow a custom application in another AWS account to push events to AWS Lambda by invoking your function.

Returns:

  • (Object) —

    The principal who is getting this permission. It can be Amazon S3 service Principal (s3.amazonaws.com ) if you want Amazon S3 to invoke the function, an AWS account ID if you are granting cross-account permission, or any valid AWS service principal such as sns.amazonaws.com . For example, you might want to allow a custom application in another AWS account to push events to AWS Lambda by invoking your function.



34
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/lambda_policy.rb', line 34

attribute :principal

#source_account ⇒ Object?

Returns The AWS account ID (without a hyphen) of the source owner. For example, if the SourceArn identifies a bucket, then this is the bucket owner’s account ID. You can use this additional condition to ensure the bucket you specify is owned by a specific account (it is possible the bucket owner deleted the bucket and some other AWS account created the bucket). You can also use this condition to specify all sources (that is, you don’t specify the SourceArn ) owned by a specific account.

Returns:

  • (Object, nil) —

    The AWS account ID (without a hyphen) of the source owner. For example, if the SourceArn identifies a bucket, then this is the bucket owner’s account ID. You can use this additional condition to ensure the bucket you specify is owned by a specific account (it is possible the bucket owner deleted the bucket and some other AWS account created the bucket). You can also use this condition to specify all sources (that is, you don’t specify the SourceArn ) owned by a specific account.



41
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/lambda_policy.rb', line 41

attribute :source_account

#source_arn ⇒ Object?

Returns This is optional; however, when granting Amazon S3 permission to invoke your function, you should specify this field with the bucket Amazon Resource Name (ARN) as its value. This ensures that only events generated from the specified bucket can invoke the function.

Returns:

  • (Object, nil) —

    This is optional; however, when granting Amazon S3 permission to invoke your function, you should specify this field with the bucket Amazon Resource Name (ARN) as its value. This ensures that only events generated from the specified bucket can invoke the function.



38
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/lambda_policy.rb', line 38

attribute :source_arn

#state ⇒ :present, :absent

Returns Describes the desired state.

Returns:

  • (:present, :absent) —

    Describes the desired state.



16
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/lambda_policy.rb', line 16

attribute :state

#statement_id ⇒ Object

Returns A unique statement identifier.

Returns:

  • (Object) —

    A unique statement identifier.



26
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/lambda_policy.rb', line 26

attribute :statement_id

#version ⇒ Object?

Returns Version of the Lambda function. Mutually exclusive with C(alias).

Returns:

  • (Object, nil) —

    Version of the Lambda function. Mutually exclusive with C(alias).



23
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/lambda_policy.rb', line 23

attribute :version