.. _cloud_services_cloud_provider_aws:

cloud-services cloud-provider aws
=================================

AWS Provider configuration


aws Specification
-----------------

	===================================== ==========================================================================
	 **Parameter**                         **Value** 

	===================================== ==========================================================================
	 **Type**                              *Intermediate Resource*

	 **Element Name**                      aws

	 **Element URI**                       /axapi/v3/cloud-services/cloud-provider/aws

	 **Element Attributes**                aws_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`aws schema <cloud-services-cloud-provider-aws/cloud-services-cloud-provider-aws.txt>`
	===================================== ==========================================================================





	**Operations Allowed:**




.. raw:: html

   <script type="text/javascript">
 function showExample(a,b) { document.getElementById(a+'_div').style.display = 'block'; document.getElementById(a+'_cl').style.display = 'block'; document.getElementById(a+'_eg').style.display = 'none';}
   function closeExample(a,b) { document.getElementById(a+'_div').style.display = 'none'; document.getElementById(a+'_cl').style.display = 'none'; document.getElementById(a+'_eg').style.display = 'block';}
 </script>
   <table width='90%' style='margin-left:5%'>



.. raw:: html

   <tr style='border-bottom: thin solid; border-top: thin solid'><th width=15%>Operation</th><th width=10%>Method</th><th>URI</th><th width=15%>Payload</th><th width=10%></th></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Get Object



.. raw:: html

   </td><td valign = 'top'>


GET



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/cloud-services/cloud-provider/aws



.. raw:: html

   </td><td valign = 'top'>


aws_attributes



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   </table>

.. _642_aws_attributes:

aws attributes
--------------

    **log**

        **Description:** log is a **JSON Block**.  Please see below for :ref:`642_log` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/cloud-services/cloud-provider/aws/log <cloud_services_cloud_provider_aws_log>`

    **metrics**

        **Description:** metrics is a **JSON Block**.  Please see below for :ref:`642_metrics` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/cloud-services/cloud-provider/aws/metrics <cloud_services_cloud_provider_aws_metrics>`

    **multi-az-failover**

        **Description:** multi-az-failover is a **JSON Block**.  Please see below for :ref:`642_multi-az-failover` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/cloud-services/cloud-provider/aws/multi-az-failover <cloud_services_cloud_provider_aws_multi_az_failover>`

.. _642_metrics:

metrics
^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

	=============================== ===================================================

    **action**

        **Description** 'enable': Enable AWS CloudWatch; 'disable': Disable AWS CloudWatch (default); 

        **Type:** string

        **Supported Values:** enable, disable

        **Default:** disable

    **active-partitions**

        **Description** Specifies the thunder active partition name separated by a comma for multiple values

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 255 characters

        **Maximum Length:** 1 characters

    **cps**

        **Description** 'enable': Enable CPS Metrics; 'disable': Disable CPS Metrics; 

        **Type:** string

        **Supported Values:** enable, disable

        **Default:** disable

    **cpu**

        **Description** 'enable': Enable CPU Metrics; 'disable': Disable CPU Metrics; 

        **Type:** string

        **Supported Values:** enable, disable

        **Default:** disable

    **disk**

        **Description** 'enable': Enable Disk Metrics; 'disable': Disable Disk Metrics; 

        **Type:** string

        **Supported Values:** enable, disable

        **Default:** disable

    **interfaces**

        **Description** 'enable': Enable Interfaces Metrics; 'disable': Disable Interfaces Metrics; 

        **Type:** string

        **Supported Values:** enable, disable

        **Default:** disable

    **memory**

        **Description** 'enable': Enable Memory Metrics; 'disable': Disable Memory Metrics; 

        **Type:** string

        **Supported Values:** enable, disable

        **Default:** disable

    **namespace**

        **Description** Specifies the AWS namespace where all the metrics must be published

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

    **packet-drop**

        **Description** 'enable': Enable Packet Drop Metrics; 'disable': Disable Packet Drop Metrics; 

        **Type:** string

        **Supported Values:** enable, disable

        **Default:** disable

    **packet-rate**

        **Description** 'enable': Enable Packet Rate Metrics; 'disable': Disable Packet Rate Metrics; 

        **Type:** string

        **Supported Values:** enable, disable

        **Default:** disable

    **server-down-count**

        **Description** 'enable': Enable Server Down Count Metrics; 'disable': Disable Server Down Count Metrics; 

        **Type:** string

        **Supported Values:** enable, disable

        **Default:** disable

    **server-down-percentage**

        **Description** 'enable': Enable Server Down Percentage Metrics; 'disable': Disable Server Down Percentage Metrics; 

        **Type:** string

        **Supported Values:** enable, disable

        **Default:** disable

    **server-error**

        **Description** 'enable': Enable Server Error Metrics; 'disable': Disable Server Error Metrics; 

        **Type:** string

        **Supported Values:** enable, disable

        **Default:** disable

    **sessions**

        **Description** 'enable': Enable Sessions Metrics; 'disable': Disable Sessions Metrics; 

        **Type:** string

        **Supported Values:** enable, disable

        **Default:** disable

    **ssl-cert**

        **Description** 'enable': Enable SSL Cert Metrics; 'disable': Disable SSL Cert Metrics; 

        **Type:** string

        **Supported Values:** enable, disable

        **Default:** disable

    **throughput**

        **Description** 'enable': Enable Throughput Metrics; 'disable': Disable Throughput Metrics; 

        **Type:** string

        **Supported Values:** enable, disable

        **Default:** disable

    **tps**

        **Description** 'enable': Enable TPS Metrics; 'disable': Disable TPS Metrics; 

        **Type:** string

        **Supported Values:** enable, disable

        **Default:** disable

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _642_multi-az-failover:

multi-az-failover
^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

	=============================== ===================================================

    **vrid-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/cloud-services/cloud-provider/aws/multi-az-failover/vrid/{vrid-number} <cloud_services_cloud_provider_aws_multi_az_failover_vrid>`

.. _642_multi-az-failover_vrid-list:

multi-az-failover_vrid-list
^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

	=============================== ===================================================

    **fip-dest**

        **Description** Alien FIP Destination CIDR Block

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

    **fip-interface-id**

        **Description** Data-Out Interface ID

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

    **route-table-id**

        **Description** Specifies the route table id of the interface

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

    **user-tag**

        **Description** Customized tag

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

    **vip-dest**

        **Description** Alien VIP Destination CIDR Block

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

    **vip-interface-id**

        **Description** Data-In Interface ID

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

    **vip-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/cloud-services/cloud-provider/aws/multi-az-failover/vrid/{vrid-number}/vip/{vip-number} <cloud_services_cloud_provider_aws_multi_az_failover_vrid>`

    **vrid-number**

        **Description** Specify ha VRRP-A vrid Number

        **Type:** number

        **Range:** 0-31

.. _642_multi-az-failover_vrid-list_vip-list:

multi-az-failover_vrid-list_vip-list
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

	=============================== ===================================================

    **elastic-ip**

        **Description** Elastic IP address of VIP

        **Type:** string

        **Format:** ipv4-address

    **private-ip**

        **Description** Private IP address of VIP

        **Type:** string

        **Format:** ipv4-address

    **user-tag**

        **Description** Customized tag

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

    **vip-number**

        **Description** Specify ha vip Number

        **Type:** number

        **Range:** 0-2147483647

.. _642_log:

log
^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

	=============================== ===================================================

    **action**

        **Description** 'enable': Enable AWS CloudWatch; 'disable': Disable AWS CloudWatch (default); 

        **Type:** string

        **Supported Values:** enable, disable

        **Default:** disable

    **active-partitions**

        **Description** Specifies the thunder active partition name separated by a comma for multiple values

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 255 characters

        **Maximum Length:** 1 characters

    **log-group-name**

        **Description** Specifies the log group name under which all logs are sent to AWS CloudWatch

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters