-
Notifications
You must be signed in to change notification settings - Fork 9.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #33706 from hashicorp/d-cdktf-docs-6374270807-37
cdktf: update documentation
- Loading branch information
Showing
84 changed files
with
2,970 additions
and
174 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
83 changes: 83 additions & 0 deletions
83
website/docs/cdktf/python/d/fsx_ontap_file_system.html.markdown
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,83 @@ | ||
--- | ||
subcategory: "FSx" | ||
layout: "aws" | ||
page_title: "AWS: aws_fsx_ontap_file_system" | ||
description: |- | ||
Retrieve information on FSx ONTAP File System. | ||
--- | ||
|
||
|
||
<!-- Please do not edit this file, it is generated. --> | ||
# Data Source: aws_fsx_ontap_file_system | ||
|
||
Retrieve information on FSx ONTAP File System. | ||
|
||
## Example Usage | ||
|
||
### Basic Usage | ||
|
||
```python | ||
# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug | ||
from constructs import Construct | ||
from cdktf import TerraformStack | ||
# | ||
# Provider bindings are generated by running `cdktf get`. | ||
# See https://cdk.tf/provider-generation for more details. | ||
# | ||
from imports.aws.data_aws_fsx_ontap_file_system import DataAwsFsxOntapFileSystem | ||
class MyConvertedCode(TerraformStack): | ||
def __init__(self, scope, name): | ||
super().__init__(scope, name) | ||
DataAwsFsxOntapFileSystem(self, "example", | ||
id="fs-12345678" | ||
) | ||
``` | ||
|
||
## Argument Reference | ||
|
||
The following arguments are required: | ||
|
||
* `id` - (Required) Identifier of the file system (e.g. `fs-12345678`). | ||
|
||
## Attributes Reference | ||
|
||
In addition to all arguments above, the following attributes are exported: | ||
|
||
* `arn` - Amazon Resource Name of the file system. | ||
* `automatic_backup_retention_days` - The number of days to retain automatic backups. | ||
* `daily_automatic_backup_start_time` - The preferred time (in `HH:MM` format) to take daily automatic backups, in the UTC time zone. | ||
* `deployment_type` - The file system deployment type. | ||
* `disk_iops_configuration` - The SSD IOPS configuration for the Amazon FSx for NetApp ONTAP file system, specifying the number of provisioned IOPS and the provision mode. See [Disk IOPS](#disk-iops) Below. | ||
* `dns_name` - DNS name for the file system (e.g. `fs-12345678.corp.example.com`). | ||
* `endpoint_ip_address_range` - (Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system exist. | ||
* `endpoints` - The Management and Intercluster FileSystemEndpoints that are used to access data or to manage the file system using the NetApp ONTAP CLI, REST API, or NetApp SnapMirror. See [FileSystemEndpoints](#file-system-endpoints) below. | ||
* `id` - Identifier of the file system (e.g. `fs-12345678`). | ||
* `kms_key_id` - ARN for the KMS Key to encrypt the file system at rest. | ||
* `network_interface_ids` - The IDs of the elastic network interfaces from which a specific file system is accessible. | ||
* `owner_id` - AWS account identifier that created the file system. | ||
* `preferred_subnet_id` - Specifies the subnet in which you want the preferred file server to be located. | ||
* `route_table_ids` - (Multi-AZ only) The VPC route tables in which your file system's endpoints exist. | ||
* `storage_capacity` - The storage capacity of the file system in gibibytes (GiB). | ||
* `storage_type` - The type of storage the file system is using. If set to `SSD`, the file system uses solid state drive storage. If set to `HDD`, the file system uses hard disk drive storage. | ||
* `subnet_ids` - Specifies the IDs of the subnets that the file system is accessible from. For the MULTI_AZ_1 file system deployment type, there are two subnet IDs, one for the preferred file server and one for the standby file server. The preferred file server subnet identified in the `preferred_subnet_id` property. | ||
* `tags` - The tags associated with the file system. | ||
* `throughput_capacity` - The sustained throughput of an Amazon FSx file system in Megabytes per second (MBps). | ||
* `vpc_id` - The ID of the primary virtual private cloud (VPC) for the file system. | ||
* `weekly_maintenance_start_time` - The preferred start time (in `D:HH:MM` format) to perform weekly maintenance, in the UTC time zone. | ||
|
||
### Disk IOPS | ||
|
||
* `iops` - The total number of SSD IOPS provisioned for the file system. | ||
* `mode` - Specifies whether the file system is using the `AUTOMATIC` setting of SSD IOPS of 3 IOPS per GB of storage capacity, or if it using a `USER_PROVISIONED` value. | ||
|
||
### File System Endpoints | ||
|
||
* `intercluster` - A FileSystemEndpoint for managing your file system by setting up NetApp SnapMirror with other ONTAP systems. See [FileSystemEndpoint](#file-system-endpoint) below. | ||
* `management` - A FileSystemEndpoint for managing your file system using the NetApp ONTAP CLI and NetApp ONTAP API. See [FileSystemEndpoint](#file-system-endpoint) below. | ||
|
||
### File System Endpoint | ||
|
||
* `DNSName` - The file system's DNS name. You can mount your file system using its DNS name. | ||
* `IpAddresses` - IP addresses of the file system endpoint. | ||
|
||
<!-- cache-key: cdktf-0.18.0 input-459fa001b98c16cffb882c5412b5d97d3d6335c21e394631f65f1e2eade0cc2d --> |
124 changes: 124 additions & 0 deletions
124
website/docs/cdktf/python/d/fsx_ontap_storage_virtual_machine.html.markdown
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,124 @@ | ||
--- | ||
subcategory: "FSx" | ||
layout: "aws" | ||
page_title: "AWS: aws_fsx_ontap_storage_virtual_machine" | ||
description: |- | ||
Retrieve information on FSx ONTAP Storage Virtual Machine (SVM). | ||
--- | ||
|
||
|
||
<!-- Please do not edit this file, it is generated. --> | ||
# Data Source: aws_fsx_ontap_storage_virtual_machine | ||
|
||
Retrieve information on FSx ONTAP Storage Virtual Machine (SVM). | ||
|
||
## Example Usage | ||
|
||
### Basic Usage | ||
|
||
```python | ||
# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug | ||
from constructs import Construct | ||
from cdktf import TerraformStack | ||
# | ||
# Provider bindings are generated by running `cdktf get`. | ||
# See https://cdk.tf/provider-generation for more details. | ||
# | ||
from imports.aws.data_aws_fsx_ontap_storage_virtual_machine import DataAwsFsxOntapStorageVirtualMachine | ||
class MyConvertedCode(TerraformStack): | ||
def __init__(self, scope, name): | ||
super().__init__(scope, name) | ||
DataAwsFsxOntapStorageVirtualMachine(self, "example", | ||
id="svm-12345678" | ||
) | ||
``` | ||
|
||
### Filter Example | ||
|
||
```python | ||
# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug | ||
from constructs import Construct | ||
from cdktf import TerraformStack | ||
# | ||
# Provider bindings are generated by running `cdktf get`. | ||
# See https://cdk.tf/provider-generation for more details. | ||
# | ||
from imports.aws.data_aws_fsx_ontap_storage_virtual_machine import DataAwsFsxOntapStorageVirtualMachine | ||
class MyConvertedCode(TerraformStack): | ||
def __init__(self, scope, name): | ||
super().__init__(scope, name) | ||
DataAwsFsxOntapStorageVirtualMachine(self, "example", | ||
filter=[DataAwsFsxOntapStorageVirtualMachineFilter( | ||
name="file-system-id", | ||
values=["fs-12345678"] | ||
) | ||
] | ||
) | ||
``` | ||
|
||
## Argument Reference | ||
|
||
The arguments of this data source act as filters for querying the available ONTAP Storage Virtual Machines in the current region. The given filters must match exactly one Storage Virtual Machine whose data will be exported as attributes. | ||
|
||
The following arguments are optional: | ||
|
||
* `filter` - (Optional) Configuration block. Detailed below. | ||
* `id` - (Optional) Identifier of the storage virtual machine (e.g. `svm-12345678`). | ||
|
||
### filter | ||
|
||
This block allows for complex filters. | ||
|
||
The following arguments are required: | ||
|
||
* `name` - (Required) Name of the field to filter by, as defined by [the underlying AWS API](https://docs.aws.amazon.com/fsx/latest/APIReference/API_StorageVirtualMachineFilter.html). | ||
* `values` - (Required) Set of values that are accepted for the given field. An SVM will be selected if any one of the given values matches. | ||
|
||
## Attributes Reference | ||
|
||
In addition to all arguments above, the following attributes are exported: | ||
|
||
* `arn` - Amazon Resource Name of the SVM. | ||
* `active_directory_configuration` - The Microsoft Active Directory configuration to which the SVM is joined, if applicable. See [Active Directory Configuration](#active-directory-configuration) below. | ||
* `creation_time` - The time that the SVM was created. | ||
* `endpoints` - The endpoints that are used to access data or to manage the SVM using the NetApp ONTAP CLI, REST API, or NetApp CloudManager. They are the Iscsi, Management, Nfs, and Smb endpoints. See [SVM Endpoints](#svm-endpoints) below. | ||
* `file_system_id` - Identifier of the file system (e.g. `fs-12345678`). | ||
* `id` - The SVM's system generated unique ID. | ||
* `lifecycle_status` - The SVM's lifecycle status. | ||
* `lifecycle_transition_reason` - Describes why the SVM lifecycle state changed. See [Lifecycle Transition Reason](#lifecycle-transition-reason) below. | ||
* `name` - The name of the SVM, if provisioned. | ||
* `subtype` - The SVM's subtype. | ||
* `uuid` - The SVM's UUID. | ||
|
||
### Active Directory Configuration | ||
|
||
The following arguments are supported for `active_directory_configuration` configuration block: | ||
|
||
* `netbios_name` - The NetBIOS name of the AD computer object to which the SVM is joined. | ||
* `self_managed_active_directory` - The configuration of the self-managed Microsoft Active Directory (AD) directory to which the Windows File Server or ONTAP storage virtual machine (SVM) instance is joined. See [Self Managed Active Directory](#self-managed-active-directory) below. | ||
|
||
### Self Managed Active Directory | ||
|
||
* `dns_ips` - A list of up to three IP addresses of DNS servers or domain controllers in the self-managed AD directory. | ||
* `domain_name` - The fully qualified domain name of the self-managed AD directory. | ||
* `file_system_administrators_group` - The name of the domain group whose members have administrative privileges for the FSx file system. | ||
* `organizational_unit_distinguished_name` - The fully qualified distinguished name of the organizational unit within the self-managed AD directory to which the Windows File Server or ONTAP storage virtual machine (SVM) instance is joined. | ||
* `username` - The user name for the service account on your self-managed AD domain that FSx uses to join to your AD domain. | ||
|
||
### Lifecycle Transition Reason | ||
|
||
* `message` - A detailed message. | ||
|
||
### SVM Endpoints | ||
|
||
* `Iscsi` - An endpoint for connecting using the Internet Small Computer Systems Interface (iSCSI) protocol. See [SVM Endpoint](#svm-endpoint) below. | ||
* `management` - An endpoint for managing SVMs using the NetApp ONTAP CLI, NetApp ONTAP API, or NetApp CloudManager. See [SVM Endpoint](#svm-endpoint) below. | ||
* `nfs` - An endpoint for connecting using the Network File System (NFS) protocol. See [SVM Endpoint](#svm-endpoint) below. | ||
* `smb` - An endpoint for connecting using the Server Message Block (SMB) protocol. See [SVM Endpoint](#svm-endpoint) below. | ||
|
||
### SVM Endpoint | ||
|
||
* `DNSName` - The file system's DNS name. You can mount your file system using its DNS name. | ||
* `IpAddresses` - The SVM endpoint's IP addresses. | ||
|
||
<!-- cache-key: cdktf-0.18.0 input-f6cea127fecc9fef03f1751e79c3dcabeee15d54d55425580842b9e868758d48 --> |
57 changes: 57 additions & 0 deletions
57
website/docs/cdktf/python/d/fsx_ontap_storage_virtual_machines.html.markdown
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,57 @@ | ||
--- | ||
subcategory: "FSx" | ||
layout: "aws" | ||
page_title: "AWS: aws_fsx_ontap_storage_virtual_machines" | ||
description: |- | ||
This resource can be useful for getting back a set of FSx ONTAP Storage Virtual Machine (SVM) IDs. | ||
--- | ||
|
||
|
||
<!-- Please do not edit this file, it is generated. --> | ||
# Data Source: aws_fsx_ontap_storage_virtual_machines | ||
|
||
This resource can be useful for getting back a set of FSx ONTAP Storage Virtual Machine (SVM) IDs. | ||
|
||
## Example Usage | ||
|
||
The following shows outputting all SVM IDs for a given FSx ONTAP File System. | ||
|
||
```python | ||
# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug | ||
from constructs import Construct | ||
from cdktf import TerraformStack | ||
# | ||
# Provider bindings are generated by running `cdktf get`. | ||
# See https://cdk.tf/provider-generation for more details. | ||
# | ||
from imports.aws.data_aws_fsx_ontap_storage_virtual_machines import DataAwsFsxOntapStorageVirtualMachines | ||
class MyConvertedCode(TerraformStack): | ||
def __init__(self, scope, name): | ||
super().__init__(scope, name) | ||
DataAwsFsxOntapStorageVirtualMachines(self, "example", | ||
filter=[DataAwsFsxOntapStorageVirtualMachinesFilter( | ||
name="file-system-id", | ||
values=["fs-12345678"] | ||
) | ||
] | ||
) | ||
``` | ||
|
||
## Argument Reference | ||
|
||
* `filter` - (Optional) Configuration block. Detailed below. | ||
|
||
### filter | ||
|
||
This block allows for complex filters. | ||
|
||
The following arguments are required: | ||
|
||
* `name` - (Required) Name of the field to filter by, as defined by [the underlying AWS API](https://docs.aws.amazon.com/fsx/latest/APIReference/API_StorageVirtualMachineFilter.html). | ||
* `values` - (Required) Set of values that are accepted for the given field. An SVM will be selected if any one of the given values matches. | ||
|
||
## Attributes Reference | ||
|
||
* `ids` - List of all SVM IDs found. | ||
|
||
<!-- cache-key: cdktf-0.18.0 input-fe65afdf53d4c09b7ace920dfb5af1c86aa9ada3e1dee3a6a467d53273829e75 --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
55 changes: 55 additions & 0 deletions
55
website/docs/cdktf/python/d/organizations_organizational_unit.html.markdown
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,55 @@ | ||
--- | ||
subcategory: "Organizations" | ||
layout: "aws" | ||
page_title: "AWS: aws_organizations_organizational_unit" | ||
description: |- | ||
Terraform data source for getting an AWS Organizations Organizational Unit. | ||
--- | ||
|
||
|
||
<!-- Please do not edit this file, it is generated. --> | ||
# Data Source: aws_organizations_organizational_unit | ||
|
||
Terraform data source for getting an AWS Organizations Organizational Unit. | ||
|
||
## Example Usage | ||
|
||
### Basic Usage | ||
|
||
```python | ||
# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug | ||
from constructs import Construct | ||
from cdktf import Fn, Token, TerraformStack | ||
# | ||
# Provider bindings are generated by running `cdktf get`. | ||
# See https://cdk.tf/provider-generation for more details. | ||
# | ||
from imports.aws.data_aws_organizations_organization import DataAwsOrganizationsOrganization | ||
from imports.aws.data_aws_organizations_organizational_unit import DataAwsOrganizationsOrganizationalUnit | ||
class MyConvertedCode(TerraformStack): | ||
def __init__(self, scope, name): | ||
super().__init__(scope, name) | ||
org = DataAwsOrganizationsOrganization(self, "org") | ||
DataAwsOrganizationsOrganizationalUnit(self, "ou", | ||
name="dev", | ||
parent_id=Token.as_string(Fn.lookup_nested(org.roots, ["0", "id"])) | ||
) | ||
``` | ||
|
||
## Argument Reference | ||
|
||
The following arguments are required: | ||
|
||
* `parent_id` - (Required) Parent ID of the organizational unit. | ||
|
||
* `name` - (Required) Name of the organizational unit | ||
|
||
## Attribute Reference | ||
|
||
This data source exports the following attributes in addition to the arguments above: | ||
|
||
* `arn` - ARN of the organizational unit | ||
|
||
* `id` - ID of the organizational unit | ||
|
||
<!-- cache-key: cdktf-0.18.0 input-e56dc041babcb69fcbea16355a3a2d9d89e93f6d8fb748bce77dcff633eefa4b --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.