Show / Hide Table of Contents

Class CfnProject

A CloudFormation AWS::IoT1Click::Project.

Inheritance
System.Object
Construct
CfnElement
CfnRefElement
CfnResource
CfnProject
Implements
IConstruct
Constructs.IConstruct
IDependable
IInspectable
Inherited Members
CfnResource.IsCfnResource(IConstruct)
CfnResource.AddDeletionOverride(String)
CfnResource.AddDependsOn(CfnResource)
CfnResource.AddMetadata(String, Object)
CfnResource.AddOverride(String, Object)
CfnResource.AddPropertyDeletionOverride(String)
CfnResource.AddPropertyOverride(String, Object)
CfnResource.ApplyRemovalPolicy(Nullable<RemovalPolicy>, IRemovalPolicyOptions)
CfnResource.GetAtt(String)
CfnResource.GetMetadata(String)
CfnResource.ShouldSynthesize()
CfnResource.ToString()
CfnResource.ValidateProperties(Object)
CfnResource.CfnOptions
CfnResource.CfnResourceType
CfnResource.UpdatedProperites
CfnRefElement.Ref
CfnElement.IsCfnElement(Object)
CfnElement.OverrideLogicalId(String)
CfnElement.CreationStack
CfnElement.LogicalId
CfnElement.Stack
Construct.IsConstruct(Object)
Construct.OnPrepare()
Construct.OnSynthesize(ISynthesisSession)
Construct.OnValidate()
Construct.Prepare()
Construct.Synthesize(ISynthesisSession)
Construct.Validate()
Construct.Node
Namespace: Amazon.CDK.AWS.IoT1Click
Assembly: Amazon.CDK.AWS.IoT1Click.dll
Syntax (csharp)
public class CfnProject : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnProject
    Inherits CfnResource
    Implements IConstruct, IDependable, IInspectable
Remarks

The AWS::IoT1Click::Project resource creates an empty project with a placement template. A project contains zero or more placements that adhere to the placement template defined in the project. For more information, see CreateProject in the AWS IoT 1-Click Projects API Reference .

CloudformationResource: AWS::IoT1Click::Project

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot1click-project.html

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.IoT1Click;

var callbackOverrides;
var defaultAttributes;

var cfnProject = new CfnProject(this, "MyCfnProject", new CfnProjectProps {
    PlacementTemplate = new PlacementTemplateProperty {
        DefaultAttributes = defaultAttributes,
        DeviceTemplates = new Dictionary<string, object> {
            { "deviceTemplatesKey", new DeviceTemplateProperty {
                CallbackOverrides = callbackOverrides,
                DeviceType = "deviceType"
            } }
        }
    },

    // the properties below are optional
    Description = "description",
    ProjectName = "projectName"
});

Synopsis

Constructors

CfnProject(Construct, String, ICfnProjectProps)

Create a new AWS::IoT1Click::Project.

CfnProject(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

CfnProject(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

Properties

AttrArn

The Amazon Resource Name (ARN) of the project, such as arn:aws:iot1click:us-east-1:123456789012:projects/project-a1bzhi .

AttrProjectName

The name of the project, such as project-a1bzhi .

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

CfnProperties
Description

The description of the project.

PlacementTemplate

An object describing the project's placement specifications.

ProjectName

The name of the project from which to obtain information.

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

RenderProperties(IDictionary<String, Object>)

Constructors

CfnProject(Construct, String, ICfnProjectProps)

Create a new AWS::IoT1Click::Project.

public CfnProject(Construct scope, string id, ICfnProjectProps props)
Parameters
scope Construct
  • scope in which this resource is defined.
id System.String
  • scoped id of the resource.
props ICfnProjectProps
  • resource properties.

CfnProject(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected CfnProject(ByRefValue reference)
Parameters
reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

CfnProject(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected CfnProject(DeputyBase.DeputyProps props)
Parameters
props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

Properties

AttrArn

The Amazon Resource Name (ARN) of the project, such as arn:aws:iot1click:us-east-1:123456789012:projects/project-a1bzhi .

public virtual string AttrArn { get; }
Property Value

System.String

Remarks

CloudformationAttribute: Arn

AttrProjectName

The name of the project, such as project-a1bzhi .

public virtual string AttrProjectName { get; }
Property Value

System.String

Remarks

CloudformationAttribute: ProjectName

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value

System.String

CfnProperties

protected override IDictionary<string, object> CfnProperties { get; }
Property Value

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides
CfnResource.CfnProperties

Description

The description of the project.

public virtual string Description { get; set; }
Property Value

System.String

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot1click-project.html#cfn-iot1click-project-description

PlacementTemplate

An object describing the project's placement specifications.

public virtual object PlacementTemplate { get; set; }
Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot1click-project.html#cfn-iot1click-project-placementtemplate

ProjectName

The name of the project from which to obtain information.

public virtual string ProjectName { get; set; }
Property Value

System.String

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot1click-project.html#cfn-iot1click-project-projectname

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)
Parameters
inspector TreeInspector
  • tree inspector to collect and process attributes.

RenderProperties(IDictionary<String, Object>)

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides
CfnResource.RenderProperties(IDictionary<String, Object>)

Implements

IConstruct
Constructs.IConstruct
IDependable
IInspectable
Back to top Generated by DocFX