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

add sagemaker resource types #2

Merged
merged 16 commits into from
Dec 28, 2020
Merged
Show file tree
Hide file tree
Changes from 11 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
49 changes: 49 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# Compiled class file
*.class

# Log file
*.log

# BlueJ files
*.ctxt

# Mobile Tools for Java (J2ME)
.mtj.tmp/

# Package Files #
*.jar
*.war
*.nar
*.ear
*.zip
*.tar.gz
*.rar

# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
hs_err_pid*

# IDE configurations
*.iml
.vscode/

# Build
target/
build

# Generated Files
.classpath
.factorypath
.project
.settings/
.gradle/

# MacOS
.DS_Store

# IntelliJ
*.iml
.idea
out.java
out/
.settings
.project
16 changes: 16 additions & 0 deletions aws-sagemaker-dataqualityjobdefinition/.rpdk-config
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
{
"typeName": "AWS::SageMaker::DataQualityJobDefinition",
"language": "java",
"runtime": "java8",
"entrypoint": "software.amazon.sagemaker.dataqualityjobdefinition.HandlerWrapper::handleRequest",
"testEntrypoint": "software.amazon.sagemaker.dataqualityjobdefinition.HandlerWrapper::testEntrypoint",
"settings": {
"namespace": [
"software",
"amazon",
"sagemaker",
"dataqualityjobdefinition"
],
"protocolVersion": "2.0.0"
}
}
178 changes: 178 additions & 0 deletions aws-sagemaker-dataqualityjobdefinition/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,178 @@
# AWS::SageMaker::DataQualityJobDefinition

Resource Type definition for AWS::SageMaker::DataQualityJobDefinition

## Syntax

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

### JSON

<pre>
{
"Type" : "AWS::SageMaker::DataQualityJobDefinition",
"Properties" : {
"<a href="#jobdefinitionname" title="JobDefinitionName">JobDefinitionName</a>" : <i>String</i>,
"<a href="#dataqualitybaselineconfig" title="DataQualityBaselineConfig">DataQualityBaselineConfig</a>" : <i><a href="dataqualitybaselineconfig.md">DataQualityBaselineConfig</a></i>,
"<a href="#dataqualityappspecification" title="DataQualityAppSpecification">DataQualityAppSpecification</a>" : <i><a href="dataqualityappspecification.md">DataQualityAppSpecification</a></i>,
"<a href="#dataqualityjobinput" title="DataQualityJobInput">DataQualityJobInput</a>" : <i><a href="dataqualityjobinput.md">DataQualityJobInput</a></i>,
"<a href="#dataqualityjoboutputconfig" title="DataQualityJobOutputConfig">DataQualityJobOutputConfig</a>" : <i><a href="monitoringoutputconfig.md">MonitoringOutputConfig</a></i>,
"<a href="#jobresources" title="JobResources">JobResources</a>" : <i><a href="monitoringresources.md">MonitoringResources</a></i>,
"<a href="#networkconfig" title="NetworkConfig">NetworkConfig</a>" : <i><a href="networkconfig.md">NetworkConfig</a></i>,
"<a href="#rolearn" title="RoleArn">RoleArn</a>" : <i>String</i>,
"<a href="#stoppingcondition" title="StoppingCondition">StoppingCondition</a>" : <i><a href="stoppingcondition.md">StoppingCondition</a></i>,
"<a href="#tags" title="Tags">Tags</a>" : <i>[ <a href="tag.md">Tag</a>, ... ]</i>,
}
}
</pre>

### YAML

<pre>
Type: AWS::SageMaker::DataQualityJobDefinition
Properties:
<a href="#jobdefinitionname" title="JobDefinitionName">JobDefinitionName</a>: <i>String</i>
<a href="#dataqualitybaselineconfig" title="DataQualityBaselineConfig">DataQualityBaselineConfig</a>: <i><a href="dataqualitybaselineconfig.md">DataQualityBaselineConfig</a></i>
<a href="#dataqualityappspecification" title="DataQualityAppSpecification">DataQualityAppSpecification</a>: <i><a href="dataqualityappspecification.md">DataQualityAppSpecification</a></i>
<a href="#dataqualityjobinput" title="DataQualityJobInput">DataQualityJobInput</a>: <i><a href="dataqualityjobinput.md">DataQualityJobInput</a></i>
<a href="#dataqualityjoboutputconfig" title="DataQualityJobOutputConfig">DataQualityJobOutputConfig</a>: <i><a href="monitoringoutputconfig.md">MonitoringOutputConfig</a></i>
<a href="#jobresources" title="JobResources">JobResources</a>: <i><a href="monitoringresources.md">MonitoringResources</a></i>
<a href="#networkconfig" title="NetworkConfig">NetworkConfig</a>: <i><a href="networkconfig.md">NetworkConfig</a></i>
<a href="#rolearn" title="RoleArn">RoleArn</a>: <i>String</i>
<a href="#stoppingcondition" title="StoppingCondition">StoppingCondition</a>: <i><a href="stoppingcondition.md">StoppingCondition</a></i>
<a href="#tags" title="Tags">Tags</a>: <i>
- <a href="tag.md">Tag</a></i>
</pre>

## Properties

#### JobDefinitionName

The name of the job definition.

_Required_: No

_Type_: String

_Maximum_: <code>63</code>

_Pattern_: <code>^[a-zA-Z0-9](-*[a-zA-Z0-9])*$</code>

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

#### DataQualityBaselineConfig

Baseline configuration used to validate that the data conforms to the specified constraints and statistics.

_Required_: No

_Type_: <a href="dataqualitybaselineconfig.md">DataQualityBaselineConfig</a>

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

#### DataQualityAppSpecification

Container image configuration object for the monitoring job.

_Required_: Yes

_Type_: <a href="dataqualityappspecification.md">DataQualityAppSpecification</a>

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

#### DataQualityJobInput

The inputs for a monitoring job.

_Required_: Yes

_Type_: <a href="dataqualityjobinput.md">DataQualityJobInput</a>

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

#### DataQualityJobOutputConfig

The output configuration for monitoring jobs.

_Required_: Yes

_Type_: <a href="monitoringoutputconfig.md">MonitoringOutputConfig</a>

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

#### JobResources

Identifies the resources to deploy for a monitoring job.

_Required_: Yes

_Type_: <a href="monitoringresources.md">MonitoringResources</a>

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

#### NetworkConfig

Networking options for a job, such as network traffic encryption between containers, whether to allow inbound and outbound network calls to and from containers, and the VPC subnets and security groups to use for VPC-enabled jobs.

_Required_: No

_Type_: <a href="networkconfig.md">NetworkConfig</a>

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

#### RoleArn

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.

_Required_: Yes

_Type_: String

_Minimum_: <code>20</code>

_Maximum_: <code>2048</code>

_Pattern_: <code>^arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$</code>

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

#### StoppingCondition

Specifies a time limit for how long the monitoring job is allowed to run.

_Required_: No

_Type_: <a href="stoppingcondition.md">StoppingCondition</a>

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

#### Tags

An array of key-value pairs to apply to this resource.

_Required_: No

_Type_: List of <a href="tag.md">Tag</a>

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

## Return Values

### Ref

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

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

#### CreationTime

The time at which the job definition was created.

#### JobDefinitionArn

The Amazon Resource Name (ARN) of job definition.

Loading