Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update TypeScript library to newer version #10

Draft
wants to merge 3 commits into
base: master
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file modified images/typescript.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
11 changes: 7 additions & 4 deletions typescript/brianterry-unicorn-maker.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,19 +3,22 @@
"description": "A resource that creates unicorns.",
"sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git",
"properties": {
"UID": {
"Id": {
"description": "The ID of the majestic animal",
"pattern": "^[a-z0-9]+$",
"type": "string"
},
"Name": {
"description": "The name of the majestic animal",
"type": "string",
"pattern": "^[a-zA-Z0-9]+$",
"minLength": 3,
"maxLength": 250
},
"Color": {
"description": "The Color of the majestic animal",
"description": "The color of the majestic animal",
"type": "string",
"pattern": "^[a-zA-Z0-9]+$",
"minLength": 3,
"maxLength": 250
}
Expand All @@ -26,10 +29,10 @@
"Color"
],
"readOnlyProperties": [
"/properties/UID"
"/properties/Id"
],
"primaryIdentifier": [
"/properties/UID"
"/properties/Id"
],
"handlers": {
"create": {
Expand Down
79 changes: 79 additions & 0 deletions typescript/docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
# Brianterry::Unicorn::Maker

A resource that creates unicorns.

## Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

### JSON

<pre>
{
"Type" : "Brianterry::Unicorn::Maker",
"Properties" : {
"<a href="#name" title="Name">Name</a>" : <i>String</i>,
"<a href="#color" title="Color">Color</a>" : <i>String</i>
}
}
</pre>

### YAML

<pre>
Type: Brianterry::Unicorn::Maker
Properties:
<a href="#name" title="Name">Name</a>: <i>String</i>
<a href="#color" title="Color">Color</a>: <i>String</i>
</pre>

## Properties

#### Name

The name of the majestic animal

_Required_: Yes

_Type_: String

_Minimum_: <code>3</code>

_Maximum_: <code>250</code>

_Pattern_: <code>^[a-zA-Z0-9]+$</code>

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

#### Color

The color of the majestic animal

_Required_: Yes

_Type_: String

_Minimum_: <code>3</code>

_Maximum_: <code>250</code>

_Pattern_: <code>^[a-zA-Z0-9]+$</code>

_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 Id.

### 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).

#### Id

The ID of the majestic animal

Loading