Package software.amazon.awscdk.services.iottwinmaker

Class CfnSyncJob

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.iottwinmaker.CfnSyncJob

All Implemented Interfaces:

IInspectable, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
           date="2024-10-11T15:56:00.510Z")
@Stability(Stable)
public class CfnSyncJob
extends CfnResource
implements IInspectable, ITaggable

The SyncJob.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.iottwinmaker.*;
 CfnSyncJob cfnSyncJob = CfnSyncJob.Builder.create(this, "MyCfnSyncJob")
         .syncRole("syncRole")
         .syncSource("syncSource")
         .workspaceId("workspaceId")
         // the properties below are optional
         .tags(Map.of(
                 "tagsKey", "tags"))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-syncjob.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnSyncJob.Builder	A fluent builder for CfnSyncJob.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable

ITaggable.Jsii$Default, ITaggable.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnSyncJob(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnSyncJob(software.amazon.jsii.JsiiObjectRef objRef)
	CfnSyncJob(software.constructs.Construct scope, String id, CfnSyncJobProps props)

Method Summary

Modifier and Type	Method	Description
String	getAttrArn()	The SyncJob ARN.
String	getAttrCreationDateTime()	The creation date and time of the SyncJob.
String	getAttrState()	The SyncJob's state.
String	getAttrUpdateDateTime()	The update date and time.
protected Map<String,Object>	getCfnProperties()
String	getSyncRole()	The SyncJob IAM role.
String	getSyncSource()	The sync source.
TagManager	getTags()	Tag Manager which manages the tags for this resource.
Map<String,String>	getTagsRaw()	Metadata you can use to manage the SyncJob.
String	getWorkspaceId()	The ID of the workspace that contains the sync job.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setSyncRole(String value)	The SyncJob IAM role.
void	setSyncSource(String value)	The sync source.
void	setTagsRaw(Map<String,String> value)	Metadata you can use to manage the SyncJob.
void	setWorkspaceId(String value)	The ID of the workspace that contains the sync job.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnSyncJob

protected CfnSyncJob(software.amazon.jsii.JsiiObjectRef objRef)

CfnSyncJob

protected CfnSyncJob(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnSyncJob

@Stability(Stable)
public CfnSyncJob(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnSyncJobProps props)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(Stable)
@NotNull
public String getAttrArn()

The SyncJob ARN.

getAttrCreationDateTime

@Stability(Stable)
@NotNull
public String getAttrCreationDateTime()

The creation date and time of the SyncJob.

getAttrState

@Stability(Stable)
@NotNull
public String getAttrState()

The SyncJob's state.

getAttrUpdateDateTime

@Stability(Stable)
@NotNull
public String getAttrUpdateDateTime()

The update date and time.

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(Stable)
@NotNull
public TagManager getTags()

Tag Manager which manages the tags for this resource.

Specified by:

getTags in interface ITaggable

getSyncRole

@Stability(Stable)
@NotNull
public String getSyncRole()

The SyncJob IAM role.

setSyncRole

@Stability(Stable)
public void setSyncRole(@NotNull
 String value)

The SyncJob IAM role.

getSyncSource

@Stability(Stable)
@NotNull
public String getSyncSource()

The sync source.

setSyncSource

@Stability(Stable)
public void setSyncSource(@NotNull
 String value)

The sync source.

getWorkspaceId

@Stability(Stable)
@NotNull
public String getWorkspaceId()

The ID of the workspace that contains the sync job.

setWorkspaceId

@Stability(Stable)
public void setWorkspaceId(@NotNull
 String value)

The ID of the workspace that contains the sync job.

getTagsRaw

@Stability(Stable)
@Nullable
public Map<String,String> getTagsRaw()

Metadata you can use to manage the SyncJob.

setTagsRaw

@Stability(Stable)
public void setTagsRaw(@Nullable
 Map<String,String> value)

Metadata you can use to manage the SyncJob.