software.amazon.awscdk.services.workspaces

Class CfnConnectionAlias

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.workspaces.CfnConnectionAlias

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:40.834Z")
public class CfnConnectionAlias
extends CfnResource
implements IInspectable

A CloudFormation `AWS::WorkSpaces::ConnectionAlias`.

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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static 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 interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnConnectionAlias(Construct scope, java.lang.String id, CfnConnectionAliasProps props) Create a new `AWS::WorkSpaces::ConnectionAlias`.
protected	CfnConnectionAlias(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnConnectionAlias(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAttrAliasId() The identifier of the connection alias, returned as a string.
IResolvable	getAttrAssociations() The association status of the connection alias, returned as an array of `ConnectionAliasAssociation` objects.
java.lang.String	getAttrConnectionAliasState() The current state of the connection alias, returned as a string.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getConnectionString() The connection string specified for the connection alias.
TagManager	getTags() The tags to associate with the connection alias.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setConnectionString(java.lang.String value) The connection string specified for the connection alias.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

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

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnConnectionAlias

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

CfnConnectionAlias

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

CfnConnectionAlias

public CfnConnectionAlias(Construct scope,
                          java.lang.String id,
                          CfnConnectionAliasProps props)

Create a new `AWS::WorkSpaces::ConnectionAlias`.

Parameters:

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

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

public void inspect(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

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrAliasId

public java.lang.String getAttrAliasId()

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

getAttrAssociations

public IResolvable getAttrAssociations()

The association status of the connection alias, returned as an array of `ConnectionAliasAssociation` objects.

getAttrConnectionAliasState

public java.lang.String getAttrConnectionAliasState()

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

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

public TagManager getTags()

The tags to associate with the connection alias.

getConnectionString

public java.lang.String getConnectionString()

The connection string specified for the connection alias.

The connection string must be in the form of a fully qualified domain name (FQDN), such as www.example.com .

setConnectionString

public void setConnectionString(java.lang.String value)

The connection string specified for the connection alias.

The connection string must be in the form of a fully qualified domain name (FQDN), such as www.example.com .