ansible-collections/google.cloud
1
0
Fork 0
mirror of https://github.com/ansible-collections/google.cloud.git synced 2025-07-11 23:50:56 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

adding ansible types in documentation (#303)

Browse source 
Signed-off-by: Modular Magician <magic-modules@google.com>
This commit is contained in:
The Magician 2019-07-16 14:19:07 -07:00 • committed by Alex Stephen
parent 72e4cc7214
commit 43536a1e38
81 changed files with 844 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

43
plugins/modules/gcp_storage_bucket.py
View file

@ -56,6 +56,7 @@ options:
description:
- Access controls on the bucket.
required: false
type: list
suboptions:
bucket:
description:
@ -66,6 +67,7 @@ options:
to a gcp_storage_bucket task and then set this bucket field to "{{ name-of-resource
}}"'
required: true
type: dict
entity:
description:
- 'The entity holding the permission, in one of the following forms: user-userId
@ -76,59 +78,71 @@ options:
- To refer to all members of the Google Apps for Business domain example.com,
the entity would be domain-example.com.
required: true
type: str
entity_id:
description:
- The ID for the entity.
required: false
type: str
project_team:
description:
- The project team associated with the entity.
required: false
type: dict
suboptions:
project_number:
description:
- The project team associated with the entity.
required: false
type: str
team:
description:
- The team.
- 'Some valid choices include: "editors", "owners", "viewers"'
required: false
type: str
role:
description:
- The access permission for the entity.
- 'Some valid choices include: "OWNER", "READER", "WRITER"'
required: false
type: str
cors:
description:
- The bucket's Cross-Origin Resource Sharing (CORS) configuration.
required: false
type: list
suboptions:
max_age_seconds:
description:
- The value, in seconds, to return in the Access-Control-Max-Age header used
in preflight responses.
required: false
type: int
method:
description:
- 'The list of HTTP methods on which to include CORS response headers, (GET,
OPTIONS, POST, etc) Note: "*" is permitted in the list of methods, and means
"any method".'
required: false
type: list
origin:
description:
- The list of Origins eligible to receive CORS response headers.
- 'Note: "*" is permitted in the list of origins, and means "any Origin".'
required: false
type: list
response_header:
description:
- The list of HTTP headers other than the simple response headers to give
permission for the user-agent to share across domains.
required: false
type: list
default_object_acl:
description:
- Default access controls to apply to new objects when no ACL is provided.
required: false
type: list
version_added: 2.7
suboptions:
bucket:
@ -140,6 +154,7 @@ options:
to a gcp_storage_bucket task and then set this bucket field to "{{ name-of-resource
}}"'
required: true
type: dict
entity:
description:
- 'The entity holding the permission, in one of the following forms: * user-{{userId}}
@ -148,58 +163,69 @@ options:
(such as "domain-example.com") * project-team-{{projectId}} * allUsers *
allAuthenticatedUsers .'
required: true
type: str
object:
description:
- The name of the object, if applied to an object.
required: false
type: str
role:
description:
- The access permission for the entity.
- 'Some valid choices include: "OWNER", "READER"'
required: true
type: str
lifecycle:
description:
- The bucket's lifecycle configuration.
- See U(https://developers.google.com/storage/docs/lifecycle) for more information.
required: false
type: dict
suboptions:
rule:
description:
- A lifecycle management rule, which is made of an action to take and the
condition(s) under which the action will be taken.
required: false
type: list
suboptions:
action:
description:
- The action to take.
required: false
type: dict
suboptions:
storage_class:
description:
- Target storage class. Required iff the type of the action is SetStorageClass.
required: false
type: str
type:
description:
- Type of the action. Currently, only Delete and SetStorageClass are
supported.
- 'Some valid choices include: "Delete", "SetStorageClass"'
required: false
type: str
condition:
description:
- The condition(s) under which the action will be taken.
required: false
type: dict
suboptions:
age_days:
description:
- Age of an object (in days). This condition is satisfied when an
object reaches the specified age.
required: false
type: int
created_before:
description:
- A date in RFC 3339 format with only the date part (for instance,
"2013-01-15"). This condition is satisfied when an object is created
before midnight of the specified date in UTC.
required: false
type: str
is_live:
description:
- Relevant only for versioned objects. If the value is true, this
@ -213,49 +239,59 @@ options:
will be matched. Values include MULTI_REGIONAL, REGIONAL, NEARLINE,
COLDLINE, STANDARD, and DURABLE_REDUCED_AVAILABILITY.
required: false
type: list
num_newer_versions:
description:
- Relevant only for versioned objects. If the value is N, this condition
is satisfied when there are at least N versions (including the live
version) newer than this version of the object.
required: false
type: int
location:
description:
- The location of the bucket. Object data for objects in the bucket resides in
physical storage within this region. Defaults to US. See the developer's guide
for the authoritative list.
required: false
type: str
logging:
description:
- The bucket's logging configuration, which defines the destination bucket and
optional name prefix for the current bucket's logs.
required: false
type: dict
suboptions:
log_bucket:
description:
- The destination bucket where the current bucket's logs should be placed.
required: false
type: str
log_object_prefix:
description:
- A prefix for log object names.
required: false
type: str
metageneration:
description:
- The metadata generation of this bucket.
required: false
type: int
name:
description:
- The name of the bucket.
required: false
type: str
owner:
description:
- The owner of the bucket. This is always the project team's owner group.
required: false
type: dict
suboptions:
entity:
description:
- The entity, in the form project-owner-projectId.
required: false
type: str
storage_class:
description:
- The bucket's default storage class, used whenever no storageClass is specified
@ -267,10 +303,12 @@ options:
- 'Some valid choices include: "MULTI_REGIONAL", "REGIONAL", "STANDARD", "NEARLINE",
"COLDLINE", "DURABLE_REDUCED_AVAILABILITY"'
required: false
type: str
versioning:
description:
- The bucket's versioning configuration.
required: false
type: dict
suboptions:
enabled:
description:
@ -283,6 +321,7 @@ options:
accessing bucket contents as a web site. See the Static Website Examples for
more information.
required: false
type: dict
suboptions:
main_page_suffix:
description:
@ -291,16 +330,19 @@ options:
object. This allows the creation of index.html objects to represent directory
pages.
required: false
type: str
not_found_page:
description:
- If the requested object path is missing, and any mainPageSuffix object is
missing, if applicable, the service will return the named object from this
bucket as the content for a 404 Not Found result.
required: false
type: str
project:
description:
- A valid API project identifier.
required: false
type: str
predefined_default_object_acl:
description:
- Apply a predefined set of default object access controls to this bucket.
@ -317,6 +359,7 @@ options:
- 'Some valid choices include: "authenticatedRead", "bucketOwnerFullControl",
"bucketOwnerRead", "private", "projectPrivate", "publicRead"'
required: false
type: str
extends_documentation_fragment: gcp
'''