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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:42.830Z")
 @Stability(value=Stable)
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 class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

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

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnConnectionAlias(software.constructs.Construct scope, 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
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.
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() 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.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, 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 Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final 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

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

@Stability(value=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(value=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(value=Stable)
 @NotNull
public String getAttrAliasId()

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

getAttrAssociations

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

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

getAttrConnectionAliasState

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

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

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getTags

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

The tags to associate with the connection alias.

getConnectionString

@Stability(value=Stable)
 @NotNull
public 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

@Stability(value=Stable)
public void setConnectionString(@NotNull
                                                         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 .