Skip to content

Commit

Permalink
added documentation, list of resource providers
Browse files Browse the repository at this point in the history
  • Loading branch information
OlafConijn committed Aug 21, 2020
1 parent 1e534f8 commit 69a9dd2
Show file tree
Hide file tree
Showing 16 changed files with 46 additions and 146 deletions.
2 changes: 1 addition & 1 deletion cloud-formation/delay/community-cloudformation-delay.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"typeName": "Community::CloudFormation::Delay",
"description": "Resource schema for Community::CloudFormation::Delay.",
"description": "Resource that waits for a specified time period.",
"sourceUrl": "https://github.com/org-formation/aws-resource-providers.git",
"definitions": {},
"properties": {
Expand Down
10 changes: 7 additions & 3 deletions cloud-formation/delay/docs/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Community::CloudFormation::Delay

Resource schema for Community::CloudFormation::Delay.
Resource that waits for a specified time period.

## Syntax

Expand Down Expand Up @@ -29,13 +29,17 @@ Properties:

#### Duration

The length of time that AWS CloudFormation waits. The maximum time that you can specify is 12 hours. The value must be in ISO8601 duration format, in the form: "PT#H#M#S", where each # is the number of hours, minutes, and seconds, respectively.
The length of time that AWS CloudFormation should wait. The maximum time that you can specify is 12 hours. The value must be in ISO8601 duration format, in the form: "PT#H#M#S", where each # is the number of hours, minutes, and seconds, respectively.

_Required_: No

_Type_: String

_Pattern_: <code>^PT(?=[0-9])([0-1]?[0-9]H)?([0-9]+M)?([0-9]+S)?$</code>
_Minimum_: <code>4</code>

_Maximum_: <code>15</code>

_Pattern_: <code>^PT(?=[0-9])([0-1]?[0-9]H)?([0-9]{1,3}M)?([0-9]{1,5}S)?$</code>

_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

Expand Down
2 changes: 1 addition & 1 deletion cloud-formation/delay/resource-role.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Resources:
ExecutionRole:
Type: AWS::IAM::Role
Properties:
MaxSessionDuration: 8400
MaxSessionDuration: 43200
AssumeRolePolicyDocument:
Version: '2012-10-17'
Statement:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"typeName": "Community::Organizations::EbsEncryptionDefaults",
"description": "CloudFormation Resource Provider for AWS account defaults.",
"description": "Region level EBS encryption defaults: encryption enabled/disabled and KmsKeyId.",
"sourceUrl": "https://github.com/org-formation/aws-resource-providers.git",
"definitions": {

Expand Down
2 changes: 1 addition & 1 deletion iam/password-policy/community-iam-passwordpolicy.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"typeName": "Community::IAM::PasswordPolicy",
"description": "Resource schema for Community::IAM::PasswordPolicy.",
"description": "Resource that allows for the creation of an IAM Password Policy (applies to entire account).",
"sourceUrl": "https://github.com/org-formation/aws-resource-providers.git",
"definitions": {},
"properties": {
Expand Down
2 changes: 1 addition & 1 deletion iam/password-policy/docs/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Community::IAM::PasswordPolicy

Resource schema for Community::IAM::PasswordPolicy.
Resource that allows for the creation of an IAM Password Policy (applies to entire account).

## Syntax

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"typeName": "Community::IAM::SamlProvider",
"description": "An example resource schema demonstrating some basic constructs and validation rules.",
"description": "Resource that can be used to create a SAML based Identity Provider.",
"sourceUrl": "https://github.com/org-formation/aws-resource-providers.git",
"definitions": {
},
Expand Down
2 changes: 1 addition & 1 deletion iam/saml-provider/docs/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Community::IAM::SamlProvider

An example resource schema demonstrating some basic constructs and validation rules.
Resource that can be used to create a SAML based Identity Provider.

## Syntax

Expand Down
Empty file added iam/saml-provider/readme.md
Empty file.
16 changes: 16 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# AWS Resource Providers

A community driven repository where you can find AWS Resource Type Providers for different purposes (including org-formation ones)

## Resources


| Resource | Description | Status | usage| installation
|---|---|---|---|---|
| Community::IAM::PasswordPolicy | Resource that allows for the creation of an IAM Password Policy (applies to entire account) | in progress | [docs](iam/password-policy/docs/README.md) | todo |
| Community::IAM::SamlProvider | Resource that allows for the creation of an SAML based Identity Provider | in progress | [docs](iam/saml-provider/docs/README.md) | todo |
| Community::ServiceQuotas::CloudFormation | Custom Service Quota limits for CloudFormation resources. e.g: to increase the maximum number of stacks per account | in progress | [docs](service-quotas/cloud-formation/docs/README.md) | todo |
| Community::ServiceQuotas::S3 | Custom Service Quota limits for S3 resources. e.g: to increase the maximum number of buckets per account | in progress |[docs](service-quotas/s3/docs/README.md) | todo |
| Community::EC2::EbsEncryptionDefaults | Region level EBS encryption defaults: encryption enabled/disabled and KmsKeyId | in progress | [docs](ec2/ebs-encryption-defaults/docs/README.md) | todo |
| Community::S3::PublicAccessBlock | Account level public access block (applies to all buckets within account) | planned | todo | todo |
| Community::CloudFormation::Delay | Resource that waits for a specified time period. | in progress | [docs](cloud-formation/delay/docs/README.md) | todo |
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"typeName": "Community::ServiceQuotas::CloudFormation",
"description": "An example resource schema demonstrating some basic constructs and validation rules.",
"description": "Custom Service Quota limits for CloudFormation resources. e.g: to increase the maximum number of stacks per account.",
"sourceUrl": "https://github.com/org-formation/aws-resource-providers.git",
"definitions": {

Expand Down
2 changes: 1 addition & 1 deletion service-quotas/cloud-formation/docs/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Community::ServiceQuotas::CloudFormation

An example resource schema demonstrating some basic constructs and validation rules.
Custom Service Quota limits for CloudFormation resources. e.g: to increase the maximum number of stacks per account.

## Syntax

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"typeName": "Community::ServiceQuotas::S3",
"description": "An example resource schema demonstrating some basic constructs and validation rules.",
"description": "Custom Service Quota limits for S3 resources. e.g: to increase the maximum number of buckets per account.",
"sourceUrl": "https://github.com/org-formation/aws-resource-providers.git",
"definitions": {
},
Expand Down
97 changes: 9 additions & 88 deletions service-quotas/s3/docs/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Community::ServiceQuotas::S3

An example resource schema demonstrating some basic constructs and validation rules.
Custom Service Quota limits for S3 resources. e.g: to increase the maximum number of buckets per account.

## Syntax

Expand All @@ -12,14 +12,7 @@ To declare this entity in your AWS CloudFormation template, use the following sy
{
"Type" : "Community::ServiceQuotas::S3",
"Properties" : {
"<a href="#title" title="Title">Title</a>" : <i>String</i>,
"<a href="#coversheetincluded" title="CoverSheetIncluded">CoverSheetIncluded</a>" : <i>Boolean</i>,
"<a href="#duedate" title="DueDate">DueDate</a>" : <i>String</i>,
"<a href="#approvaldate" title="ApprovalDate">ApprovalDate</a>" : <i>String</i>,
"<a href="#memo" title="Memo">Memo</a>" : <i><a href="memo.md">Memo</a></i>,
"<a href="#secondcopyofmemo" title="SecondCopyOfMemo">SecondCopyOfMemo</a>" : <i><a href="memo.md">Memo</a></i>,
"<a href="#testcode" title="TestCode">TestCode</a>" : <i>String</i>,
"<a href="#authors" title="Authors">Authors</a>" : <i>[ String, ... ]</i>
"<a href="#buckets" title="Buckets">Buckets</a>" : <i>Integer</i>,
}
}
</pre>
Expand All @@ -29,106 +22,34 @@ To declare this entity in your AWS CloudFormation template, use the following sy
<pre>
Type: Community::ServiceQuotas::S3
Properties:
<a href="#title" title="Title">Title</a>: <i>String</i>
<a href="#coversheetincluded" title="CoverSheetIncluded">CoverSheetIncluded</a>: <i>Boolean</i>
<a href="#duedate" title="DueDate">DueDate</a>: <i>String</i>
<a href="#approvaldate" title="ApprovalDate">ApprovalDate</a>: <i>String</i>
<a href="#memo" title="Memo">Memo</a>: <i><a href="memo.md">Memo</a></i>
<a href="#secondcopyofmemo" title="SecondCopyOfMemo">SecondCopyOfMemo</a>: <i><a href="memo.md">Memo</a></i>
<a href="#testcode" title="TestCode">TestCode</a>: <i>String</i>
<a href="#authors" title="Authors">Authors</a>: <i>
- String</i>
<a href="#buckets" title="Buckets">Buckets</a>: <i>Integer</i>
</pre>

## Properties

#### Title
#### Buckets

The title of the TPS report is a mandatory element.

_Required_: Yes

_Type_: String

_Minimum_: <code>20</code>

_Maximum_: <code>250</code>

_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

#### CoverSheetIncluded

Required for all TPS Reports submitted after 2/19/1999

_Required_: No

_Type_: Boolean

_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

#### DueDate

_Required_: No

_Type_: String

_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

#### ApprovalDate

_Required_: No

_Type_: String

_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

#### Memo

_Required_: No

_Type_: <a href="memo.md">Memo</a>

_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

#### SecondCopyOfMemo

_Required_: No

_Type_: <a href="memo.md">Memo</a>

_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

#### TestCode

_Required_: Yes

_Type_: String

_Allowed Values_: <code>NOT_STARTED</code> | <code>CANCELLED</code>

_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

#### Authors
The number of Amazon S3 buckets that you can create in an account (default = 100).

_Required_: No

_Type_: List of String
_Type_: Integer

_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return Values

### Ref

When you pass the logical ID of this resource to the intrinsic `Ref` function, Ref returns the TPSCode.
When you pass the logical ID of this resource to the intrinsic `Ref` function, Ref returns the ResourceId.

### Fn::GetAtt

The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the `Fn::GetAtt` intrinsic function, see [Fn::GetAtt](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-getatt.html).

#### TPSCode
#### ResourceId

A TPS Code is automatically generated on creation and assigned as the unique identifier.
Returns the <code>ResourceId</code> value.

40 changes: 0 additions & 40 deletions service-quotas/s3/docs/memo.md

This file was deleted.

9 changes: 4 additions & 5 deletions service-quotas/s3/resource-role.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,10 @@ Resources:
Statement:
- Effect: Allow
Action:
- "initech:CreateReport"
- "initech:DeleteReport"
- "initech:DescribeReport"
- "initech:ListReports"
- "initech:UpdateReport"
- "cloudformation:DescribeAccountLimits"
- "servicequotas:getServiceQuota"
- "servicequotas:listRequestedServiceQuotaChangeHistoryByQuota"
- "servicequotas:requestServiceQuotaIncrease"
Resource: "*"
Outputs:
ExecutionRoleArn:
Expand Down

0 comments on commit 69a9dd2

Please sign in to comment.