requires
This is the requires side of the interface layer, for use in charms that
wish to request integration with AWS native features. The integration will
be provided by the AWS integration charm, which allows the requiring charm
to not require cloud credentials itself and not have a lot of AWS specific
API code.
The flags that are set by the requires side of this interface are:
* **`endpoint.{endpoint_name}.joined`** This flag is set when the relation
has been joined, and the charm should then use the methods documented below
to request specific AWS features. This flag is automatically removed if
the relation is broken. It should not be removed by the charm.
* **`endpoint.{endpoint_name}.ready`** This flag is set once the requested
features have been enabled for the AWS instance on which the charm is
running. This flag is automatically removed if new integration features
are requested. It should not be removed by the charm.
AWSIntegrationRequires
```python
AWSIntegrationRequires(self, *args, **kwargs)
```
Example usage:
```python
from charms.reactive import when, endpoint_from_flag
@when('endpoint.aws.joined')
def request_aws_integration():
aws = endpoint_from_flag('endpoint.aws.joined')
aws.request_instance_tags({
'tag1': 'value1',
'tag2': None,
})
aws.request_load_balancer_management()
# ...
@when('endpoint.aws.ready')
def aws_integration_ready():
update_config_enable_aws()
```
instance_id
This unit's instance-id.
region
The region this unit is in.
tag_instance
```python
AWSIntegrationRequires.tag_instance(self, tags)
```
Request that the given tags be applied to this instance.
__Parameters__
- __`tags` (dict)__: Mapping of tag names to values (or `None`).
tag_instance_security_group
```python
AWSIntegrationRequires.tag_instance_security_group(self, tags)
```
Request that the given tags be applied to this instance's
machine-specific security group (firewall) created by Juju.
__Parameters__
- __`tags` (dict)__: Mapping of tag names to values (or `None`).
tag_instance_subnet
```python
AWSIntegrationRequires.tag_instance_subnet(self, tags)
```
Request that the given tags be applied to this instance's subnet.
__Parameters__
- __`tags` (dict)__: Mapping of tag names to values (or `None`).
enable_acm_readonly
```python
AWSIntegrationRequires.enable_acm_readonly(self)
```
Request readonly for ACM.
enable_acm_fullaccess
```python
AWSIntegrationRequires.enable_acm_fullaccess(self)
```
Request fullaccess for ACM.
enable_instance_inspection
```python
AWSIntegrationRequires.enable_instance_inspection(self)
```
Request the ability to inspect instances.
enable_network_management
```python
AWSIntegrationRequires.enable_network_management(self)
```
Request the ability to manage networking (firewalls, subnets, etc).
enable_load_balancer_management
```python
AWSIntegrationRequires.enable_load_balancer_management(self)
```
Request the ability to manage load balancers.
enable_block_storage_management
```python
AWSIntegrationRequires.enable_block_storage_management(self)
```
Request the ability to manage block storage.
enable_dns_management
```python
AWSIntegrationRequires.enable_dns_management(self)
```
Request the ability to manage DNS.
enable_object_storage_access
```python
AWSIntegrationRequires.enable_object_storage_access(self, patterns=None)
```
Request the ability to access object storage.
__Parameters__
- __`patterns` (list)__: If given, restrict access to the resources matching
the patterns. If patterns do not start with the S3 ARN prefix
- __(`arn__:aws:s3:::`), it will be prepended.
enable_object_storage_management
```python
AWSIntegrationRequires.enable_object_storage_management(self, patterns=None)
```
Request the ability to manage object storage.
__Parameters__
- __`patterns` (list)__: If given, restrict management to the resources
matching the patterns. If patterns do not start with the S3 ARN
- __prefix (`arn__:aws:s3:::`), it will be prepended.