Package software.amazon.awscdk.services.workspaces

Class CfnConnectionAlias

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.workspaces.CfnConnectionAlias

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.97.0 (build 729de35)",
           date="2024-04-18T17:54:26.023Z")
@Stability(Stable)
public class CfnConnectionAlias
extends CfnResource
implements IInspectable, ITaggable

The AWS::WorkSpaces::ConnectionAlias resource specifies a connection alias.

Connection aliases are used for cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces .

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.workspaces.*;
 CfnConnectionAlias cfnConnectionAlias = CfnConnectionAlias.Builder.create(this, "MyCfnConnectionAlias")
         .connectionString("connectionString")
         // the properties below are optional
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspaces-connectionalias.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnConnectionAlias.Builder	A fluent builder for CfnConnectionAlias.
static interface	CfnConnectionAlias.ConnectionAliasAssociationProperty	Describes a connection alias association that is used for cross-Region redirection.

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	CfnConnectionAlias(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnConnectionAlias(software.amazon.jsii.JsiiObjectRef objRef)
	CfnConnectionAlias(software.constructs.Construct scope, String id, CfnConnectionAliasProps props)

Method Summary

Modifier and Type	Method	Description
String	getAttrAliasId()	The identifier of the connection alias, returned as a string.
IResolvable	getAttrAssociations()	The association status of the connection alias.
String	getAttrConnectionAliasState()	The current state of the connection alias, returned as a string.
protected Map<String,Object>	getCfnProperties()
String	getConnectionString()	The connection string specified for the connection alias.
TagManager	getTags()	Tag Manager which manages the tags for this resource.
List<CfnTag>	getTagsRaw()	The tags to associate with the connection alias.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setConnectionString(String value)	The connection string specified for the connection alias.
void	setTagsRaw(List<CfnTag> value)	The tags to associate with the connection alias.

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

CfnConnectionAlias

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

CfnConnectionAlias

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

CfnConnectionAlias

@Stability(Stable)
public CfnConnectionAlias(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnConnectionAliasProps 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.

getAttrAliasId

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

The identifier of the connection alias, returned as a string.

getAttrAssociations

@Stability(Stable)
@NotNull
public IResolvable getAttrAssociations()

The association status of the connection alias.

getAttrConnectionAliasState

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

The current state of the connection alias, returned as a string.

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

getConnectionString

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

The connection string specified for the connection alias.

setConnectionString

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

The connection string specified for the connection alias.

getTagsRaw

@Stability(Stable)
@Nullable
public List<CfnTag> getTagsRaw()

The tags to associate with the connection alias.

setTagsRaw

@Stability(Stable)
public void setTagsRaw(@Nullable
 List<CfnTag> value)

The tags to associate with the connection alias.