Package software.amazon.awscdk.services.opsworks

Class CfnUserProfile

java.lang.Object
software.amazon.jsii.JsiiObject
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.opsworks.CfnUserProfile
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:00.639Z") @Stability(Stable) public class CfnUserProfile extends CfnResource implements IInspectable
A CloudFormation AWS::OpsWorks::UserProfile.

Describes a user's SSH information.

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

  • 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 Construct scope, @NotNull String id, @NotNull CfnUserProfileProps props)
      Create a new AWS::OpsWorks::UserProfile.

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

    • 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.

      For more information, see Managing User Permissions .

    • setAllowSelfManagement

      @Stability(Stable) public void setAllowSelfManagement(@Nullable Boolean value)
      Whether users can specify their own SSH public key through the My Settings page.

      For more information, see Managing User Permissions .

    • setAllowSelfManagement

      @Stability(Stable) public void setAllowSelfManagement(@Nullable IResolvable value)
      Whether users can specify their own SSH public key through the My Settings page.

      For more information, see Managing User Permissions .

    • 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.