Show / Hide Table of Contents

Class CfnWorkteam

A CloudFormation AWS::SageMaker::Workteam.

Inheritance
System.Object
Construct
CfnElement
CfnRefElement
CfnResource
CfnWorkteam
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.Sagemaker
Assembly: Amazon.CDK.AWS.Sagemaker.dll
Syntax (csharp)
public class CfnWorkteam : CfnResource, IConstruct, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnWorkteam
    Inherits CfnResource
    Implements IConstruct, IConstruct, IDependable, IInspectable
Remarks

Creates a new work team for labeling your data. A work team is defined by one or more Amazon Cognito user pools. You must first create the user pools before you can create a work team.

You cannot create more than 25 work teams in an account and region.

CloudformationResource: AWS::SageMaker::Workteam

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-workteam.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.Sagemaker;

CfnWorkteam cfnWorkteam = new CfnWorkteam(this, "MyCfnWorkteam", new CfnWorkteamProps {
    Description = "description",
    MemberDefinitions = new [] { new MemberDefinitionProperty {
        CognitoMemberDefinition = new CognitoMemberDefinitionProperty {
            CognitoClientId = "cognitoClientId",
            CognitoUserGroup = "cognitoUserGroup",
            CognitoUserPool = "cognitoUserPool"
        }
    } },
    NotificationConfiguration = new NotificationConfigurationProperty {
        NotificationTopicArn = "notificationTopicArn"
    },
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } },
    WorkteamName = "workteamName"
});

Synopsis

Constructors

CfnWorkteam(Construct, String, ICfnWorkteamProps)

Create a new AWS::SageMaker::Workteam.

CfnWorkteam(ByRefValue)

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

CfnWorkteam(DeputyBase.DeputyProps)

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

Properties

AttrWorkteamName

The name of the work team.

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

CfnProperties
Description

A description of the work team.

MemberDefinitions

A list of MemberDefinition objects that contains objects that identify the workers that make up the work team.

NotificationConfiguration

Configures SNS notifications of available or expiring work items for work teams.

Tags

An array of key-value pairs.

WorkteamName

The name of the work team.

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

RenderProperties(IDictionary<String, Object>)

Constructors

CfnWorkteam(Construct, String, ICfnWorkteamProps)

Create a new AWS::SageMaker::Workteam.

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

CfnWorkteam(ByRefValue)

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

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

The Javascript-owned object reference

CfnWorkteam(DeputyBase.DeputyProps)

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

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

The deputy props

Properties

AttrWorkteamName

The name of the work team.

public virtual string AttrWorkteamName { get; }
Property Value

System.String

Remarks

CloudformationAttribute: WorkteamName

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

A description of the work team.

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

System.String

Remarks

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

MemberDefinitions

A list of MemberDefinition objects that contains objects that identify the workers that make up the work team.

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

System.Object

Remarks

Workforces can be created using Amazon Cognito or your own OIDC Identity Provider (IdP). For private workforces created using Amazon Cognito use CognitoMemberDefinition . For workforces created using your own OIDC identity provider (IdP) use OidcMemberDefinition .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-workteam.html#cfn-sagemaker-workteam-memberdefinitions

NotificationConfiguration

Configures SNS notifications of available or expiring work items for work teams.

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

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-workteam.html#cfn-sagemaker-workteam-notificationconfiguration

Tags

An array of key-value pairs.

public virtual TagManager Tags { get; }
Property Value

TagManager

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-workteam.html#cfn-sagemaker-workteam-tags

WorkteamName

The name of the work team.

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

System.String

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-workteam.html#cfn-sagemaker-workteam-workteamname

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