software.amazon.awscdk.services.appstream

Class CfnStackUserAssociation

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.appstream.CfnStackUserAssociation

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:36.650Z")
 @Stability(value=Stable)
public class CfnStackUserAssociation
extends CfnResource
implements IInspectable

A CloudFormation `AWS::AppStream::StackUserAssociation`.

The AWS::AppStream::StackUserAssociation resource associates the specified users with the specified stacks for Amazon AppStream 2.0. Users in an AppStream 2.0 user pool cannot be assigned to stacks with fleets that are joined to an Active Directory domain.

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.appstream.*;
 CfnStackUserAssociation cfnStackUserAssociation = CfnStackUserAssociation.Builder.create(this, "MyCfnStackUserAssociation")
         .authenticationType("authenticationType")
         .stackName("stackName")
         .userName("userName")
         // the properties below are optional
         .sendEmailNotification(false)
         .build();
 

Nested Class Summary

Nested Classes

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

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
	CfnStackUserAssociation(software.constructs.Construct scope, String id, CfnStackUserAssociationProps props) Create a new `AWS::AppStream::StackUserAssociation`.
protected	CfnStackUserAssociation(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnStackUserAssociation(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAuthenticationType() The authentication type for the user who is associated with the stack.
protected Map<String,Object>	getCfnProperties()
Object	getSendEmailNotification() Specifies whether a welcome email is sent to a user after the user is created in the user pool.
String	getStackName() The name of the stack that is associated with the user.
String	getUserName() The email address of the user who is associated with the stack.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAuthenticationType(String value) The authentication type for the user who is associated with the stack.
void	setSendEmailNotification(Boolean value) Specifies whether a welcome email is sent to a user after the user is created in the user pool.
void	setSendEmailNotification(IResolvable value) Specifies whether a welcome email is sent to a user after the user is created in the user pool.
void	setStackName(String value) The name of the stack that is associated with the user.
void	setUserName(String value) The email address of the user who is associated with the stack.

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

CfnStackUserAssociation

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

CfnStackUserAssociation

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

CfnStackUserAssociation

@Stability(value=Stable)
public CfnStackUserAssociation(@NotNull
                                                        software.constructs.Construct scope,
                                                        @NotNull
                                                        String id,
                                                        @NotNull
                                                        CfnStackUserAssociationProps props)

Create a new `AWS::AppStream::StackUserAssociation`.

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.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getAuthenticationType

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

The authentication type for the user who is associated with the stack.

You must specify USERPOOL.

setAuthenticationType

@Stability(value=Stable)
public void setAuthenticationType(@NotNull
                                                           String value)

The authentication type for the user who is associated with the stack.

You must specify USERPOOL.

getStackName

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

The name of the stack that is associated with the user.

setStackName

@Stability(value=Stable)
public void setStackName(@NotNull
                                                  String value)

The name of the stack that is associated with the user.

getUserName

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

The email address of the user who is associated with the stack.

Users' email addresses are case-sensitive.

setUserName

@Stability(value=Stable)
public void setUserName(@NotNull
                                                 String value)

The email address of the user who is associated with the stack.

Users' email addresses are case-sensitive.

getSendEmailNotification

@Stability(value=Stable)
 @Nullable
public Object getSendEmailNotification()

Specifies whether a welcome email is sent to a user after the user is created in the user pool.

setSendEmailNotification

@Stability(value=Stable)
public void setSendEmailNotification(@Nullable
                                                              Boolean value)

Specifies whether a welcome email is sent to a user after the user is created in the user pool.

setSendEmailNotification

@Stability(value=Stable)
public void setSendEmailNotification(@Nullable
                                                              IResolvable value)

Specifies whether a welcome email is sent to a user after the user is created in the user pool.