Skip to content

Commit

Permalink
Run 'make docs'.
Browse files Browse the repository at this point in the history
  • Loading branch information
ewbankkit committed Oct 21, 2021
1 parent 2334564 commit 87d212c
Show file tree
Hide file tree
Showing 7 changed files with 210 additions and 5 deletions.
19 changes: 18 additions & 1 deletion docs/data-sources/s3objectlambda_access_point.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,24 @@ Read-Only:
Read-Only:

- **actions** (Set of String)
- **content_transformation** (Map of String)
- **content_transformation** (Attributes) (see [below for nested schema](#nestedatt--object_lambda_configuration--transformation_configurations--content_transformation))

<a id="nestedatt--object_lambda_configuration--transformation_configurations--content_transformation"></a>
### Nested Schema for `object_lambda_configuration.transformation_configurations.content_transformation`

Read-Only:

- **aws_lambda** (Attributes) (see [below for nested schema](#nestedatt--object_lambda_configuration--transformation_configurations--content_transformation--aws_lambda))

<a id="nestedatt--object_lambda_configuration--transformation_configurations--content_transformation--aws_lambda"></a>
### Nested Schema for `object_lambda_configuration.transformation_configurations.content_transformation.aws_lambda`

Read-Only:

- **function_arn** (String)
- **function_payload** (String)





Expand Down
22 changes: 21 additions & 1 deletion docs/data-sources/sagemaker_pipeline.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,33 @@ Data Source schema for AWS::SageMaker::Pipeline

### Read-Only

- **pipeline_definition** (Map of String)
- **pipeline_definition** (Attributes) (see [below for nested schema](#nestedatt--pipeline_definition))
- **pipeline_description** (String) The description of the Pipeline.
- **pipeline_display_name** (String) The display name of the Pipeline.
- **pipeline_name** (String) The name of the Pipeline.
- **role_arn** (String) Role Arn
- **tags** (Attributes List) (see [below for nested schema](#nestedatt--tags))

<a id="nestedatt--pipeline_definition"></a>
### Nested Schema for `pipeline_definition`

Read-Only:

- **pipeline_definition_body** (String) A specification that defines the pipeline in JSON format.
- **pipeline_definition_s3_location** (Attributes) (see [below for nested schema](#nestedatt--pipeline_definition--pipeline_definition_s3_location))

<a id="nestedatt--pipeline_definition--pipeline_definition_s3_location"></a>
### Nested Schema for `pipeline_definition.pipeline_definition_s3_location`

Read-Only:

- **bucket** (String) The name of the S3 bucket where the PipelineDefinition file is stored.
- **e_tag** (String) The Amazon S3 ETag (a file checksum) of the PipelineDefinition file. If you don't specify a value, SageMaker skips ETag validation of your PipelineDefinition file.
- **key** (String) The file name of the PipelineDefinition file (Amazon S3 object name).
- **version** (String) For versioning-enabled buckets, a specific version of the PipelineDefinition file.



<a id="nestedatt--tags"></a>
### Nested Schema for `tags`

Expand Down
19 changes: 18 additions & 1 deletion docs/resources/s3_storage_lens.md
Original file line number Diff line number Diff line change
Expand Up @@ -124,11 +124,28 @@ Required:

- **account_id** (String) The AWS account ID that owns the destination S3 bucket.
- **arn** (String) The ARN of the bucket to which Amazon S3 Storage Lens exports will be placed.
- **encryption** (Map of String) Configures the server-side encryption for Amazon S3 Storage Lens report files with either S3-managed keys (SSE-S3) or KMS-managed keys (SSE-KMS).
- **encryption** (Attributes) Configures the server-side encryption for Amazon S3 Storage Lens report files with either S3-managed keys (SSE-S3) or KMS-managed keys (SSE-KMS). (see [below for nested schema](#nestedatt--storage_lens_configuration--data_export--s3_bucket_destination--encryption))
- **format** (String) Specifies the file format to use when exporting Amazon S3 Storage Lens metrics export.
- **output_schema_version** (String) The version of the output schema to use when exporting Amazon S3 Storage Lens metrics.
- **prefix** (String) The prefix to use for Amazon S3 Storage Lens export.

<a id="nestedatt--storage_lens_configuration--data_export--s3_bucket_destination--encryption"></a>
### Nested Schema for `storage_lens_configuration.data_export.s3_bucket_destination.prefix`

Required:

- **ssekms** (Attributes) AWS KMS server-side encryption. (see [below for nested schema](#nestedatt--storage_lens_configuration--data_export--s3_bucket_destination--prefix--ssekms))
- **sses3** (Map of String) S3 default server-side encryption.

<a id="nestedatt--storage_lens_configuration--data_export--s3_bucket_destination--prefix--ssekms"></a>
### Nested Schema for `storage_lens_configuration.data_export.s3_bucket_destination.prefix.ssekms`

Required:

- **key_id** (String) The ARN of the KMS key to use for encryption.





<a id="nestedatt--storage_lens_configuration--exclude"></a>
Expand Down
19 changes: 18 additions & 1 deletion docs/resources/s3objectlambda_access_point.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,24 @@ Optional:
Optional:

- **actions** (Set of String)
- **content_transformation** (Map of String)
- **content_transformation** (Attributes) (see [below for nested schema](#nestedatt--object_lambda_configuration--transformation_configurations--content_transformation))

<a id="nestedatt--object_lambda_configuration--transformation_configurations--content_transformation"></a>
### Nested Schema for `object_lambda_configuration.transformation_configurations.content_transformation`

Optional:

- **aws_lambda** (Attributes) (see [below for nested schema](#nestedatt--object_lambda_configuration--transformation_configurations--content_transformation--aws_lambda))

<a id="nestedatt--object_lambda_configuration--transformation_configurations--content_transformation--aws_lambda"></a>
### Nested Schema for `object_lambda_configuration.transformation_configurations.content_transformation.aws_lambda`

Optional:

- **function_arn** (String)
- **function_payload** (String)





Expand Down
113 changes: 113 additions & 0 deletions docs/resources/s3outposts_bucket.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,113 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "awscc_s3outposts_bucket Resource - terraform-provider-awscc"
subcategory: ""
description: |-
Resource Type Definition for AWS::S3Outposts::Bucket
---

# awscc_s3outposts_bucket (Resource)

Resource Type Definition for AWS::S3Outposts::Bucket



<!-- schema generated by tfplugindocs -->
## Schema

### Required

- **bucket_name** (String) A name for the bucket.
- **outpost_id** (String) The id of the customer outpost on which the bucket resides.

### Optional

- **lifecycle_configuration** (Attributes) Rules that define how Amazon S3Outposts manages objects during their lifetime. (see [below for nested schema](#nestedatt--lifecycle_configuration))
- **tags** (Attributes List) An arbitrary set of tags (key-value pairs) for this S3Outposts bucket. (see [below for nested schema](#nestedatt--tags))

### Read-Only

- **arn** (String) The Amazon Resource Name (ARN) of the specified bucket.
- **id** (String) Uniquely identifies the resource.

<a id="nestedatt--lifecycle_configuration"></a>
### Nested Schema for `lifecycle_configuration`

Optional:

- **rules** (Attributes List) A list of lifecycle rules for individual objects in an Amazon S3Outposts bucket. (see [below for nested schema](#nestedatt--lifecycle_configuration--rules))

<a id="nestedatt--lifecycle_configuration--rules"></a>
### Nested Schema for `lifecycle_configuration.rules`

Optional:

- **abort_incomplete_multipart_upload** (Attributes) Specifies a lifecycle rule that stops incomplete multipart uploads to an Amazon S3Outposts bucket. (see [below for nested schema](#nestedatt--lifecycle_configuration--rules--abort_incomplete_multipart_upload))
- **expiration_date** (String) Indicates when objects are deleted from Amazon S3Outposts. The date value must be in ISO 8601 format. The time is always midnight UTC.
- **expiration_in_days** (Number) Indicates the number of days after creation when objects are deleted from Amazon S3Outposts.
- **filter** (Attributes) The container for the filter of the lifecycle rule. (see [below for nested schema](#nestedatt--lifecycle_configuration--rules--filter))
- **id** (String) Unique identifier for the lifecycle rule. The value can't be longer than 255 characters.
- **status** (String)

<a id="nestedatt--lifecycle_configuration--rules--abort_incomplete_multipart_upload"></a>
### Nested Schema for `lifecycle_configuration.rules.abort_incomplete_multipart_upload`

Optional:

- **days_after_initiation** (Number) Specifies the number of days after which Amazon S3Outposts aborts an incomplete multipart upload.


<a id="nestedatt--lifecycle_configuration--rules--filter"></a>
### Nested Schema for `lifecycle_configuration.rules.filter`

Optional:

- **and_operator** (Attributes) The container for the AND condition for the lifecycle rule. A combination of Prefix and 1 or more Tags OR a minimum of 2 or more tags. (see [below for nested schema](#nestedatt--lifecycle_configuration--rules--filter--and_operator))
- **prefix** (String) Object key prefix that identifies one or more objects to which this rule applies.
- **tag** (Attributes) Specifies a tag used to identify a subset of objects for an Amazon S3Outposts bucket. (see [below for nested schema](#nestedatt--lifecycle_configuration--rules--filter--tag))

<a id="nestedatt--lifecycle_configuration--rules--filter--and_operator"></a>
### Nested Schema for `lifecycle_configuration.rules.filter.tag`

Optional:

- **prefix** (String) Prefix identifies one or more objects to which the rule applies.
- **tags** (Attributes List) All of these tags must exist in the object's tag set in order for the rule to apply. (see [below for nested schema](#nestedatt--lifecycle_configuration--rules--filter--tag--tags))

<a id="nestedatt--lifecycle_configuration--rules--filter--tag--tags"></a>
### Nested Schema for `lifecycle_configuration.rules.filter.tag.tags`

Optional:

- **key** (String)
- **value** (String)



<a id="nestedatt--lifecycle_configuration--rules--filter--tag"></a>
### Nested Schema for `lifecycle_configuration.rules.filter.tag`

Optional:

- **key** (String)
- **value** (String)





<a id="nestedatt--tags"></a>
### Nested Schema for `tags`

Optional:

- **key** (String)
- **value** (String)

## Import

Import is supported using the following syntax:

```shell
$ terraform import awscc_s3outposts_bucket.example <resource ID>
```
22 changes: 21 additions & 1 deletion docs/resources/sagemaker_pipeline.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Resource Type definition for AWS::SageMaker::Pipeline

### Required

- **pipeline_definition** (Map of String)
- **pipeline_definition** (Attributes) (see [below for nested schema](#nestedatt--pipeline_definition))
- **pipeline_name** (String) The name of the Pipeline.
- **role_arn** (String) Role Arn

Expand All @@ -31,6 +31,26 @@ Resource Type definition for AWS::SageMaker::Pipeline

- **id** (String) Uniquely identifies the resource.

<a id="nestedatt--pipeline_definition"></a>
### Nested Schema for `pipeline_definition`

Required:

- **pipeline_definition_body** (String) A specification that defines the pipeline in JSON format.
- **pipeline_definition_s3_location** (Attributes) (see [below for nested schema](#nestedatt--pipeline_definition--pipeline_definition_s3_location))

<a id="nestedatt--pipeline_definition--pipeline_definition_s3_location"></a>
### Nested Schema for `pipeline_definition.pipeline_definition_s3_location`

Required:

- **bucket** (String) The name of the S3 bucket where the PipelineDefinition file is stored.
- **e_tag** (String) The Amazon S3 ETag (a file checksum) of the PipelineDefinition file. If you don't specify a value, SageMaker skips ETag validation of your PipelineDefinition file.
- **key** (String) The file name of the PipelineDefinition file (Amazon S3 object name).
- **version** (String) For versioning-enabled buckets, a specific version of the PipelineDefinition file.



<a id="nestedatt--tags"></a>
### Nested Schema for `tags`

Expand Down
1 change: 1 addition & 0 deletions examples/resources/awscc_s3outposts_bucket/import.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
$ terraform import awscc_s3outposts_bucket.example <resource ID>

0 comments on commit 87d212c

Please sign in to comment.