software.amazon.awscdk.services.appstream

Class CfnStackUserAssociation

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

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:35.471Z")
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 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
	CfnStackUserAssociation(Construct scope, java.lang.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
java.lang.String	getAuthenticationType() The authentication type for the user who is associated with the stack.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.Object	getSendEmailNotification() Specifies whether a welcome email is sent to a user after the user is created in the user pool.
java.lang.String	getStackName() The name of the stack that is associated with the user.
java.lang.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 java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setAuthenticationType(java.lang.String value) The authentication type for the user who is associated with the stack.
void	setSendEmailNotification(java.lang.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(java.lang.String value) The name of the stack that is associated with the user.
void	setUserName(java.lang.String value) The email address of the user who is associated with the stack.

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

CfnStackUserAssociation

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

CfnStackUserAssociation

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

CfnStackUserAssociation

public CfnStackUserAssociation(Construct scope,
                               java.lang.String id,
                               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

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.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getAuthenticationType

public java.lang.String getAuthenticationType()

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

You must specify USERPOOL.

setAuthenticationType

public void setAuthenticationType(java.lang.String value)

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

You must specify USERPOOL.

getStackName

public java.lang.String getStackName()

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

setStackName

public void setStackName(java.lang.String value)

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

getUserName

public java.lang.String getUserName()

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

Users' email addresses are case-sensitive.

setUserName

public void setUserName(java.lang.String value)

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

Users' email addresses are case-sensitive.

getSendEmailNotification

public java.lang.Object getSendEmailNotification()

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

setSendEmailNotification

public void setSendEmailNotification(java.lang.Boolean value)

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

setSendEmailNotification

public void setSendEmailNotification(IResolvable value)

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