Package software.amazon.awscdk.services.opsworks

Class CfnUserProfile

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.opsworks.CfnUserProfile

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:10.357Z")
@Stability(Stable)
public class CfnUserProfile
extends CfnResource
implements IInspectable

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-userprofile.html.

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.opsworks.*;
 CfnUserProfile cfnUserProfile = CfnUserProfile.Builder.create(this, "MyCfnUserProfile")
         .iamUserArn("iamUserArn")
         // the properties below are optional
         .allowSelfManagement(false)
         .sshPublicKey("sshPublicKey")
         .sshUsername("sshUsername")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-userprofile.html

Nested Class Summary

Nested Classes

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

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

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

Method Summary

Modifier and Type	Method	Description
Object	getAllowSelfManagement()	Whether users can specify their own SSH public key through the My Settings page.
String	getAttrId()
String	getAttrSshUsername()	The user's SSH user name, as a string.
protected Map<String,Object>	getCfnProperties()
String	getIamUserArn()	The user's IAM ARN.
String	getSshPublicKey()	The user's SSH public key.
String	getSshUsername()	The user's SSH user name.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAllowSelfManagement(Boolean value)	Whether users can specify their own SSH public key through the My Settings page.
void	setAllowSelfManagement(IResolvable value)	Whether users can specify their own SSH public key through the My Settings page.
void	setIamUserArn(String value)	The user's IAM ARN.
void	setSshPublicKey(String value)	The user's SSH public key.
void	setSshUsername(String value)	The user's SSH user name.

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

CfnUserProfile

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

CfnUserProfile

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

CfnUserProfile

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

getAttrId

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

getAttrSshUsername

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

The user's SSH user name, as a string.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getIamUserArn

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

The user's IAM ARN.

setIamUserArn

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

The user's IAM ARN.

getAllowSelfManagement

@Stability(Stable)
@Nullable
public Object getAllowSelfManagement()

Whether users can specify their own SSH public key through the My Settings page.

setAllowSelfManagement

@Stability(Stable)
public void setAllowSelfManagement(@Nullable
 Boolean value)

Whether users can specify their own SSH public key through the My Settings page.

setAllowSelfManagement

@Stability(Stable)
public void setAllowSelfManagement(@Nullable
 IResolvable value)

Whether users can specify their own SSH public key through the My Settings page.

getSshPublicKey

@Stability(Stable)
@Nullable
public String getSshPublicKey()

The user's SSH public key.

setSshPublicKey

@Stability(Stable)
public void setSshPublicKey(@Nullable
 String value)

The user's SSH public key.

getSshUsername

@Stability(Stable)
@Nullable
public String getSshUsername()

The user's SSH user name.

setSshUsername

@Stability(Stable)
public void setSshUsername(@Nullable
 String value)

The user's SSH user name.