Class CfnWorkforce

Resource Type definition for AWS::SageMaker::Workforce.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnWorkforce

Implements

IInspectable

IWorkforceRef

IConstruct

IDependable

IEnvironmentAware

ITaggableV2

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.AddResourceDependency(CfnResource, string)

CfnResource.ApplyCrossStackReferenceStrength(ReferenceStrength)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.CfnPropertyName(string)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.RemoveResourceDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.Env

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.With(params IMixin[])

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.Sagemaker

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnWorkforce : CfnResource, IInspectable, IWorkforceRef, IConstruct, IDependable, IEnvironmentAware, ITaggableV2

Syntax (vb)

Public Class CfnWorkforce Inherits CfnResource Implements IInspectable, IWorkforceRef, IConstruct, IDependable, IEnvironmentAware, ITaggableV2

Remarks

Use to create a private workforce that you can use to label your training data using Amazon SageMaker Ground Truth.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-workforce.html

CloudformationResource: AWS::SageMaker::Workforce

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;

             var cfnWorkforce = new CfnWorkforce(this, "MyCfnWorkforce", new CfnWorkforceProps {
                 WorkforceName = "workforceName",

                 // the properties below are optional
                 CognitoConfig = new CognitoConfigProperty {
                     ClientId = "clientId",
                     UserPool = "userPool"
                 },
                 IpAddressType = "ipAddressType",
                 OidcConfig = new OidcConfigProperty {
                     AuthorizationEndpoint = "authorizationEndpoint",
                     ClientId = "clientId",
                     Issuer = "issuer",
                     JwksUri = "jwksUri",
                     LogoutEndpoint = "logoutEndpoint",
                     TokenEndpoint = "tokenEndpoint",
                     UserInfoEndpoint = "userInfoEndpoint",

                     // the properties below are optional
                     AuthenticationRequestExtraParams = new Dictionary<string, string> {
                         { "authenticationRequestExtraParamsKey", "authenticationRequestExtraParams" }
                     },
                     ClientSecret = "clientSecret",
                     Scope = "scope"
                 },
                 SourceIpConfig = new SourceIpConfigProperty {
                     Cidrs = new [] { "cidrs" }
                 },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 WorkforceVpcConfig = new WorkforceVpcConfigRequestProperty {
                     SecurityGroupIds = new [] { "securityGroupIds" },
                     Subnets = new [] { "subnets" },
                     VpcId = "vpcId"
                 }
             });

Synopsis

Constructors

CfnWorkforce(Construct, string, ICfnWorkforceProps)

Create a new AWS::SageMaker::Workforce.

Properties

AttrSubDomain	The subdomain for your OIDC Identity Provider.
AttrWorkforceArn	The Amazon Resource Name (ARN) of the private workforce.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CdkTagManager	Tag Manager which manages the tags for this resource.
CfnProperties	Resource Type definition for AWS::SageMaker::Workforce.
CfnPropertyNames	Resource Type definition for AWS::SageMaker::Workforce.
CognitoConfig	The configuration of an Amazon Cognito workforce.
IpAddressType	The IP address type for the workforce.
OidcConfig	The configuration of an OIDC Identity Provider (IdP) private workforce.
SourceIpConfig	A list of IP address ranges used to access your training data.
Tags	An array of key-value pairs.
WorkforceName	The name of the private workforce.
WorkforceRef	A reference to a Workforce resource.
WorkforceVpcConfig	The VPC configuration for the workforce.

Methods

ArnForWorkforce(IWorkforceRef)	Resource Type definition for AWS::SageMaker::Workforce.
Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
IsCfnWorkforce(object)	Checks whether the given object is a CfnWorkforce.
RenderProperties(IDictionary<string, object>)	Resource Type definition for AWS::SageMaker::Workforce.

Constructors

CfnWorkforce(Construct, string, ICfnWorkforceProps)

Create a new AWS::SageMaker::Workforce.

public CfnWorkforce(Construct scope, string id, ICfnWorkforceProps props)

Parameters

scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnWorkforceProps

Resource properties.

Remarks

Use to create a private workforce that you can use to label your training data using Amazon SageMaker Ground Truth.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-workforce.html

CloudformationResource: AWS::SageMaker::Workforce

ExampleMetadata: fixture=_generated

Properties

AttrSubDomain

The subdomain for your OIDC Identity Provider.

public virtual string AttrSubDomain { get; }

Property Value

string

Remarks

CloudformationAttribute: SubDomain

AttrWorkforceArn

The Amazon Resource Name (ARN) of the private workforce.

public virtual string AttrWorkforceArn { get; }

Property Value

string

Remarks

CloudformationAttribute: WorkforceArn

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

Remarks

Use to create a private workforce that you can use to label your training data using Amazon SageMaker Ground Truth.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-workforce.html

CloudformationResource: AWS::SageMaker::Workforce

ExampleMetadata: fixture=_generated

CdkTagManager

Tag Manager which manages the tags for this resource.

public virtual TagManager CdkTagManager { get; }

Property Value

TagManager

Remarks

Use to create a private workforce that you can use to label your training data using Amazon SageMaker Ground Truth.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-workforce.html

CloudformationResource: AWS::SageMaker::Workforce

ExampleMetadata: fixture=_generated

CfnProperties

Resource Type definition for AWS::SageMaker::Workforce.

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

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

Use to create a private workforce that you can use to label your training data using Amazon SageMaker Ground Truth.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-workforce.html

CloudformationResource: AWS::SageMaker::Workforce

ExampleMetadata: fixture=_generated

CfnPropertyNames

Resource Type definition for AWS::SageMaker::Workforce.

protected override IDictionary<string, string> CfnPropertyNames { get; }

Property Value

IDictionary<string, string>

Overrides

CfnResource.CfnPropertyNames

Remarks

Use to create a private workforce that you can use to label your training data using Amazon SageMaker Ground Truth.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-workforce.html

CloudformationResource: AWS::SageMaker::Workforce

ExampleMetadata: fixture=_generated

CognitoConfig

The configuration of an Amazon Cognito workforce.

public virtual object? CognitoConfig { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnWorkforce.ICognitoConfigProperty

IpAddressType

The IP address type for the workforce.

public virtual string? IpAddressType { get; set; }

Property Value

string

Remarks

Use to create a private workforce that you can use to label your training data using Amazon SageMaker Ground Truth.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-workforce.html

CloudformationResource: AWS::SageMaker::Workforce

ExampleMetadata: fixture=_generated

OidcConfig

The configuration of an OIDC Identity Provider (IdP) private workforce.

public virtual object? OidcConfig { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnWorkforce.IOidcConfigProperty

SourceIpConfig

A list of IP address ranges used to access your training data.

public virtual object? SourceIpConfig { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnWorkforce.ISourceIpConfigProperty

Tags

An array of key-value pairs.

public virtual ICfnTag[]? Tags { get; set; }

Property Value

ICfnTag[]

Remarks

Use to create a private workforce that you can use to label your training data using Amazon SageMaker Ground Truth.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-workforce.html

CloudformationResource: AWS::SageMaker::Workforce

ExampleMetadata: fixture=_generated

WorkforceName

The name of the private workforce.

public virtual string WorkforceName { get; set; }

Property Value

string

Remarks

Use to create a private workforce that you can use to label your training data using Amazon SageMaker Ground Truth.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-workforce.html

CloudformationResource: AWS::SageMaker::Workforce

ExampleMetadata: fixture=_generated

WorkforceRef

A reference to a Workforce resource.

public virtual IWorkforceReference WorkforceRef { get; }

Property Value

IWorkforceReference

Remarks

Use to create a private workforce that you can use to label your training data using Amazon SageMaker Ground Truth.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-workforce.html

CloudformationResource: AWS::SageMaker::Workforce

ExampleMetadata: fixture=_generated

WorkforceVpcConfig

The VPC configuration for the workforce.

public virtual object? WorkforceVpcConfig { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnWorkforce.IWorkforceVpcConfigRequestProperty

Methods

ArnForWorkforce(IWorkforceRef)

Resource Type definition for AWS::SageMaker::Workforce.

public static string ArnForWorkforce(IWorkforceRef resource)

Parameters

resource IWorkforceRef

Returns

string

Remarks

Use to create a private workforce that you can use to label your training data using Amazon SageMaker Ground Truth.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-workforce.html

CloudformationResource: AWS::SageMaker::Workforce

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;

             var cfnWorkforce = new CfnWorkforce(this, "MyCfnWorkforce", new CfnWorkforceProps {
                 WorkforceName = "workforceName",

                 // the properties below are optional
                 CognitoConfig = new CognitoConfigProperty {
                     ClientId = "clientId",
                     UserPool = "userPool"
                 },
                 IpAddressType = "ipAddressType",
                 OidcConfig = new OidcConfigProperty {
                     AuthorizationEndpoint = "authorizationEndpoint",
                     ClientId = "clientId",
                     Issuer = "issuer",
                     JwksUri = "jwksUri",
                     LogoutEndpoint = "logoutEndpoint",
                     TokenEndpoint = "tokenEndpoint",
                     UserInfoEndpoint = "userInfoEndpoint",

                     // the properties below are optional
                     AuthenticationRequestExtraParams = new Dictionary<string, string> {
                         { "authenticationRequestExtraParamsKey", "authenticationRequestExtraParams" }
                     },
                     ClientSecret = "clientSecret",
                     Scope = "scope"
                 },
                 SourceIpConfig = new SourceIpConfigProperty {
                     Cidrs = new [] { "cidrs" }
                 },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 WorkforceVpcConfig = new WorkforceVpcConfigRequestProperty {
                     SecurityGroupIds = new [] { "securityGroupIds" },
                     Subnets = new [] { "subnets" },
                     VpcId = "vpcId"
                 }
             });

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.

Remarks

Use to create a private workforce that you can use to label your training data using Amazon SageMaker Ground Truth.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-workforce.html

CloudformationResource: AWS::SageMaker::Workforce

ExampleMetadata: fixture=_generated

IsCfnWorkforce(object)

Checks whether the given object is a CfnWorkforce.

public static bool IsCfnWorkforce(object x)

Parameters

x object

Returns

bool

Remarks

Use to create a private workforce that you can use to label your training data using Amazon SageMaker Ground Truth.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-workforce.html

CloudformationResource: AWS::SageMaker::Workforce

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

Resource Type definition for AWS::SageMaker::Workforce.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

Remarks

Use to create a private workforce that you can use to label your training data using Amazon SageMaker Ground Truth.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-workforce.html

CloudformationResource: AWS::SageMaker::Workforce

ExampleMetadata: fixture=_generated

Implements

IInspectable

IWorkforceRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware

ITaggableV2