diff --git a/docs/.buildinfo b/docs/.buildinfo index fc183557..7a71fcdb 100644 --- a/docs/.buildinfo +++ b/docs/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: 40f0495b3b7ce94d30a225fd816d2454 +config: 5bc21e0feba2ffd07ddc13514b9d709c tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/docs/_sources/df_info.rst.txt b/docs/_sources/df_info.rst.txt index df8af987..185a8c2e 100644 --- a/docs/_sources/df_info.rst.txt +++ b/docs/_sources/df_info.rst.txt @@ -44,7 +44,7 @@ Parameters | **Parameter** | **Choices/Defaults** | **Comments** | +----------------+----------------------+-----------------------------------------------------------------+ | **name** | | If a name is provided, that DataFlow Service will be described. | - | | | | + | | | Must be CDP Environment CRN or string name of DataFlow Service | | |br| | | | | | | | | ``str`` | | | diff --git a/docs/_sources/env.rst.txt b/docs/_sources/env.rst.txt index e7346137..1a84c86a 100644 --- a/docs/_sources/env.rst.txt +++ b/docs/_sources/env.rst.txt @@ -42,264 +42,264 @@ Parameters .. table:: :widths: 30 20 50 - +------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | **Parameter** | **Choices/Defaults** | **Comments** | - +------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | **name** | | The name of the target environment. | - | | | Names must begin with a lowercase alphanumeric, contain only lowercase alphanumerics and hyphens, and be between 5 to 28 characters in length. | - | |br| | | | - | | | | - | ``str`` | | | - | | | | - | |br| | | | - | | | | - | *Required* | | | - | | | | - | | | |br| | - | | | | - | | | *Aliases: environment* | - +------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | **state** | **Choices:** | The declarative state of the environment | - | | - **present** |larr| | If *state=present*, one of *cloud* or *credential* must be present. | - | |br| | - started | | - | | - stopped | | - | ``str`` | - absent | | - +------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | **cloud** | **Choices:** | The cloud provider or platform for the environment. | - | | - aws | Requires *region*, *credential*, *log_location*, and *log_identity*. | - | |br| | - azure | If *cloud=aws*, one of *public_key* or *public_key_id* must be present. | - | | - gcp | If *cloud=aws*, one of *network_cidr* or *vpc_id* must be present. | - | ``str`` | | If *cloud=aws*, one of *network_cidr* or *vpc_id* must be present. | - | | | If *cloud=aws*, one of *inbound_cidr* or *default_sg* and *knox_sg* must be present. | - +------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | **region** | | The cloud platform specified region | - | | | | - | |br| | | | - | | | | - | ``str`` | | | - +------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | **credential** | | The CDP credential associated with the environment | - | | | | - | |br| | | | - | | | | - | ``str`` | | | - +------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | **project** | | Name of Project when deploying environment on GCP | - | | | | - | |br| | | | - | | | | - | ``str`` | | | - +------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | **inbound_cidr** | | CIDR range which is allowed for inbound traffic. Either IPv4 or IPv6 is allowed. | - | | | Mutually exclusive with *default_sg* and *knox_sg*. | - | |br| | | | - | | | | - | ``str`` | | | - | | | | - | | | |br| | - | | | | - | | | *Aliases: security_cidr* | - +------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | **default_sg** | | Security group where all other hosts are placed. | - | | | Mutually exclusive with *inbound_cidr*. | - | |br| | | | - | | | | - | ``str`` | | | - | | | | - | | | |br| | - | | | | - | | | *Aliases: default, default_security_group* | - +------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | **knox_sg** | | Security group where Knox-enabled hosts are placed. | - | | | Mutually exclusive with *inbound_cidr*. | - | |br| | | | - | | | | - | ``str`` | | | - | | | | - | | | |br| | - | | | | - | | | *Aliases: knox, knox_security_group* | - +------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | **public_key_text** | | The content of a public SSH key. | - | | | Mutually exclusive with *public_key_id*. | - | |br| | | | - | | | | - | ``str`` | | | - | | | | - | | | |br| | - | | | | - | | | *Aliases: ssh_key_text* | - +------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | **public_key_id** | | The public SSH key ID already registered in the cloud provider. | - | | | Mutually exclusive with *public_key_text*. | - | |br| | | | - | | | | - | ``str`` | | | - | | | | - | | | |br| | - | | | | - | | | *Aliases: public_key, ssh_key, ssh_key_id* | - +------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | **log_location** | | (AWS) The base location to store logs in S3. This should be an s3a:// url. | - | | | | - | |br| | | | - | | | | - | ``str`` | | | - | | | | - | | | |br| | - | | | | - | | | *Aliases: storage_location_base* | - +------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | **log_identity** | | (AWS) The instance profile ARN assigned the necessary permissions to access the S3 storage location, i.e. *log_location*. | - | | | | - | |br| | | | - | | | | - | ``str`` | | | - | | | | - | | | |br| | - | | | | - | | | *Aliases: instance_profile* | - +------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | **network_cidr** | | (AWS) The network CIDR. This will create a VPC along with subnets in multiple Availability Zones. | - | | | Mutually exclusive with *vpc_id* and *subnet_ids*. | - | |br| | | | - | | | | - | ``str`` | | | - +------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | **vpc_id** | | (AWS) The VPC ID. | - | | | Mutually exclusive with *network_cidr* and requires *subnet_ids*. | - | |br| | | | - | | | | - | ``str`` | | | - | | | | - | | | |br| | - | | | | - | | | *Aliases: vpc* | - +------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | **subnet_ids** | | (AWS) One or more subnet identifiers within the VPC. | - | | | Mutually exclusive with *network_cidr* and requires *vpc_id*. | - | |br| | | | - | | | | - | ``list`` | | | - | | | | - | | | |br| | - | | | | - | | | *Aliases: subnets* | - +------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | **tags** | | Tags associated with the environment and its resources. | - | | | | - | |br| | | | - | | | | - | ``dict`` | | | - | | | | - | | | |br| | - | | | | - | | | *Aliases: environment_tags* | - +------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | **workload_analytics** | | Flag to enable diagnostic information about job and query execution to be sent to Workload Manager for Data Hub clusters created within the environment. | - | | | | - | |br| | | | - | | | | - | ``bool`` | | | - +------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | **description** | | A description for the environment. | - | | | | - | |br| | | | - | | | | - | ``str`` | | | - | | | | - | | | |br| | - | | | | - | | | *Aliases: desc* | - +------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | **tunnel** | | Flag to enable SSH tunnelling for the environment. | - | | | | - | |br| | | | - | | | | - | ``bool`` | | | - | | | | - | | | |br| | - | | | | - | | | *Aliases: enable_tunnel, ssh_tunnel* | - +------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | **freeipa** | | The FreeIPA service for the environment. | - | | | | - | |br| | | | - | | | | - | ``dict`` | | | - +------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | **proxy** | | The name of the proxy config to use for the environment. | - | | | | - | |br| | | | - | | | | - | ``str`` | | | - | | | | - | | | |br| | - | | | | - | | | *Aliases: proxy_config, proxy_config_name* | - +------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | **wait** | | Flag to enable internal polling to wait for the environment to achieve the declared state. | - | | | If set to FALSE, the module will return immediately. | - | |br| | | | - | | | | - | ``bool`` | | | - +------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | **delay** | | The internal polling interval (in seconds) while the module waits for the environment to achieve the declared state. | - | | | | - | |br| | | | - | | | | - | ``int`` | | | - | | | | - | | | |br| | - | | | | - | | | *Aliases: polling_delay* | - +------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | **timeout** | | The internal polling timeout (in seconds) while the module waits for the environment to achieve the declared state. | - | | | | - | |br| | | | - | | | | - | ``int`` | | | - | | | | - | | | |br| | - | | | | - | | | *Aliases: polling_timeout* | - +------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | **s3_guard_name** | | (AWS) AWS Dynamo table name for S3 Guard. | - | | | | - | |br| | | | - | | | | - | ``str`` | | | - | | | | - | | | |br| | - | | | | - | | | *Aliases: s3_guard, s3_guard_table_name* | - +------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | **verify_tls** | | Verify the TLS certificates for the CDP endpoint. | - | | | | - | |br| | | | - | | | | - | ``bool`` | | | - | | | | - | | | |br| | - | | | | - | | | *Aliases: tls* | - +------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | **debug** | | Capture the CDP SDK debug log. | - | | | | - | |br| | | | - | | | | - | ``bool`` | | | - | | | | - | | | |br| | - | | | | - | | | *Aliases: debug_endpoints* | - +------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | **profile** | | If provided, the CDP SDK will use this value as its profile. | - | | | | - | |br| | | | - | | | | - | ``str`` | | | - +------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | **Parameter** | **Choices/Defaults** | **Comments** | + +-----------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | **name** | | The name of the target environment. | + | | | Names must begin with a lowercase alphanumeric, contain only lowercase alphanumerics and hyphens, and be between 5 to 28 characters in length. | + | |br| | | | + | | | | + | ``str`` | | | + | | | | + | |br| | | | + | | | | + | *Required* | | | + | | | | + | | | |br| | + | | | | + | | | *Aliases: environment* | + +-----------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | **state** | **Choices:** | The declarative state of the environment | + | | - **present** |larr| | If *state=present*, one of *cloud* or *credential* must be present. | + | |br| | - started | | + | | - stopped | | + | ``str`` | - absent | | + +-----------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | **cloud** | **Choices:** | The cloud provider or platform for the environment. | + | | - aws | Requires *region*, *credential*, *log_location*, and *log_identity*. | + | |br| | - azure | If *cloud=aws*, one of *public_key* or *public_key_id* must be present. | + | | - gcp | If *cloud=aws*, one of *network_cidr* or *vpc_id* must be present. | + | ``str`` | | If *cloud=aws*, one of *network_cidr* or *vpc_id* must be present. | + | | | If *cloud=aws*, one of *inbound_cidr* or *default_sg* and *knox_sg* must be present. | + +-----------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | **region** | | The cloud platform specified region | + | | | | + | |br| | | | + | | | | + | ``str`` | | | + +-----------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | **credential** | | The CDP credential associated with the environment | + | | | | + | |br| | | | + | | | | + | ``str`` | | | + +-----------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | **project** | | Name of Project when deploying environment on GCP | + | | | | + | |br| | | | + | | | | + | ``str`` | | | + +-----------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | **inbound_cidr** | | CIDR range which is allowed for inbound traffic. Either IPv4 or IPv6 is allowed. | + | | | Mutually exclusive with *default_sg* and *knox_sg*. | + | |br| | | | + | | | | + | ``str`` | | | + | | | | + | | | |br| | + | | | | + | | | *Aliases: security_cidr* | + +-----------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | **default_sg** | | Security group where all other hosts are placed. | + | | | Mutually exclusive with *inbound_cidr*. | + | |br| | | | + | | | | + | ``str`` | | | + | | | | + | | | |br| | + | | | | + | | | *Aliases: default, default_security_group* | + +-----------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | **knox_sg** | | Security group where Knox-enabled hosts are placed. | + | | | Mutually exclusive with *inbound_cidr*. | + | |br| | | | + | | | | + | ``str`` | | | + | | | | + | | | |br| | + | | | | + | | | *Aliases: knox, knox_security_group* | + +-----------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | **public_key_text** | | The content of a public SSH key. | + | | | Mutually exclusive with *public_key_id*. | + | |br| | | | + | | | | + | ``str`` | | | + | | | | + | | | |br| | + | | | | + | | | *Aliases: ssh_key_text* | + +-----------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | **public_key_id** | | The public SSH key ID already registered in the cloud provider. | + | | | Mutually exclusive with *public_key_text*. | + | |br| | | | + | | | | + | ``str`` | | | + | | | | + | | | |br| | + | | | | + | | | *Aliases: public_key, ssh_key, ssh_key_id* | + +-----------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | **log_location** | | (AWS) The base location to store logs in S3. This should be an s3a:// url. | + | | | | + | |br| | | | + | | | | + | ``str`` | | | + | | | | + | | | |br| | + | | | | + | | | *Aliases: storage_location_base* | + +-----------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | **log_identity** | | (AWS) The instance profile ARN assigned the necessary permissions to access the S3 storage location, i.e. *log_location*. | + | | | | + | |br| | | | + | | | | + | ``str`` | | | + | | | | + | | | |br| | + | | | | + | | | *Aliases: instance_profile* | + +-----------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | **network_cidr** | | (AWS) The network CIDR. This will create a VPC along with subnets in multiple Availability Zones. | + | | | Mutually exclusive with *vpc_id* and *subnet_ids*. | + | |br| | | | + | | | | + | ``str`` | | | + +-----------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | **vpc_id** | | (AWS) The VPC ID. | + | | | Mutually exclusive with *network_cidr* and requires *subnet_ids*. | + | |br| | | | + | | | | + | ``str`` | | | + | | | | + | | | |br| | + | | | | + | | | *Aliases: vpc* | + +-----------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | **subnet_ids** | | (AWS) One or more subnet identifiers within the VPC. | + | | | Mutually exclusive with *network_cidr* and requires *vpc_id*. | + | |br| | | | + | | | | + | ``list`` | | | + | | | | + | | | |br| | + | | | | + | | | *Aliases: subnets* | + +-----------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | **tags** | | Tags associated with the environment and its resources. | + | | | | + | |br| | | | + | | | | + | ``dict`` | | | + | | | | + | | | |br| | + | | | | + | | | *Aliases: environment_tags* | + +-----------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | **workload_analytics** | | Flag to enable diagnostic information about job and query execution to be sent to Workload Manager for Data Hub clusters created within the environment. | + | | | | + | |br| | | | + | | | | + | ``bool`` | | | + +-----------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | **description** | | A description for the environment. | + | | | | + | |br| | | | + | | | | + | ``str`` | | | + | | | | + | | | |br| | + | | | | + | | | *Aliases: desc* | + +-----------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | **tunnel** | | Flag to enable SSH tunnelling for the environment. | + | | | | + | |br| | | | + | | | | + | ``bool`` | | | + | | | | + | | | |br| | + | | | | + | | | *Aliases: enable_tunnel, ssh_tunnel* | + +-----------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | **freeipa** | | The FreeIPA service for the environment. | + | | | | + | |br| | | | + | | | | + | ``dict`` | | | + +-----------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | **proxy** | | The name of the proxy config to use for the environment. | + | | | | + | |br| | | | + | | | | + | ``str`` | | | + | | | | + | | | |br| | + | | | | + | | | *Aliases: proxy_config, proxy_config_name* | + +-----------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | **wait** | | Flag to enable internal polling to wait for the environment to achieve the declared state. | + | | | If set to FALSE, the module will return immediately. | + | |br| | | | + | | | | + | ``bool`` | | | + +-----------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | **delay** | | The internal polling interval (in seconds) while the module waits for the environment to achieve the declared state. | + | | | | + | |br| | | | + | | | | + | ``int`` | | | + | | | | + | | | |br| | + | | | | + | | | *Aliases: polling_delay* | + +-----------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | **timeout** | | The internal polling timeout (in seconds) while the module waits for the environment to achieve the declared state. | + | | | | + | |br| | | | + | | | | + | ``int`` | | | + | | | | + | | | |br| | + | | | | + | | | *Aliases: polling_timeout* | + +-----------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | **endpoint_access_scheme** | **Choices:** | (AWS)The scheme for the workload endpoint gateway. PUBLIC creates an external endpoint that can be accessed over the Internet. Defaults to PRIVATE which restricts the traffic to be internal to the VPC / Vnet. Relevant in Private Networks. | + | | - PRIVATE | | + | |br| | - PUBLIC | | + +-----------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | **endpoint_access_subnets** | | (AWS) The list of subnet IDs to use for endpoint access gateway. | + | | | | + | |br| | | | + | | | | + | ``list`` | | | + +-----------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | **verify_tls** | | Verify the TLS certificates for the CDP endpoint. | + | | | | + | |br| | | | + | | | | + | ``bool`` | | | + | | | | + | | | |br| | + | | | | + | | | *Aliases: tls* | + +-----------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | **debug** | | Capture the CDP SDK debug log. | + | | | | + | |br| | | | + | | | | + | ``bool`` | | | + | | | | + | | | |br| | + | | | | + | | | *Aliases: debug_endpoints* | + +-----------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | **profile** | | If provided, the CDP SDK will use this value as its profile. | + | | | | + | |br| | | | + | | | | + | ``str`` | | | + +-----------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -431,25 +431,6 @@ Common return values are documented here, the following are fields unique to thi | | | | | a_labeled_public_key | | | | | | | +-+-+----------------------------+----------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | | **awsDetails** | when supported | AWS-specific environment configuration information. | - | | | | | - | | |br| | | | - | | | | | - | | ``dict`` | | | - +-+-+----------------------------+----------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | | | **s3GuardTableName** | always | The name for the DynamoDB table backing S3Guard. | - | | | | | | - | | | |br| | | | - | | | | | | - | | | ``str`` | | | - | | | | | | - | | | | | |br| | - | | | | | | - | | | | | **Sample:** | - | | | | | | - | | | | | table_name | - | | | | | | - +-+-+----------------------------+----------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ | | **cloudPlatform** | always | Cloud provider of the Environment. | | | | | | | | |br| | | | diff --git a/docs/_static/documentation_options.js b/docs/_static/documentation_options.js index 584dfc52..d9d4c291 100644 --- a/docs/_static/documentation_options.js +++ b/docs/_static/documentation_options.js @@ -1,6 +1,6 @@ var DOCUMENTATION_OPTIONS = { URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), - VERSION: '1.1.0', + VERSION: '1.4.0', LANGUAGE: 'None', COLLAPSE_INDEX: false, BUILDER: 'html', diff --git a/docs/account_auth.html b/docs/account_auth.html index 47e8cbb1..3458e381 100644 --- a/docs/account_auth.html +++ b/docs/account_auth.html @@ -7,7 +7,7 @@ -
str
If a name is provided, that DataFlow Service will be described.
+If a name is provided, that DataFlow Service will be described. +Must be CDP Environment CRN or string name of DataFlow Service
Aliases: crn
s3_guard_name
+endpoint_access_scheme
str
(AWS) AWS Dynamo table name for S3 Guard.
+PRIVATE
PUBLIC
(AWS)The scheme for the workload endpoint gateway. PUBLIC creates an external endpoint that can be accessed over the Internet. Defaults to PRIVATE which restricts the traffic to be internal to the VPC / Vnet. Relevant in Private Networks.
endpoint_access_subnets
Aliases: s3_guard, s3_guard_table_name
+list
(AWS) The list of subnet IDs to use for endpoint access gateway.
verify_tls
+verify_tls
bool
debug
+debug
bool
profile
+profile
str
awsDetails
-dict
when supported
AWS-specific environment configuration information.
s3GuardTableName
-str
always
The name for the DynamoDB table backing S3Guard.
-Sample:
-table_name
-cloudPlatform
str