Package software.amazon.awscdk.services.rolesanywhere

Class CfnProfile

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.rolesanywhere.CfnProfile
All Implemented Interfaces:
IInspectable, ITaggable, IProfileRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-29T11:15:47.325Z") @Stability(Stable) public class CfnProfile extends CfnResource implements IInspectable, IProfileRef, ITaggable
Creates a Profile.

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.rolesanywhere.*;
 CfnProfile cfnProfile = CfnProfile.Builder.create(this, "MyCfnProfile")
         .name("name")
         .roleArns(List.of("roleArns"))
         // the properties below are optional
         .acceptRoleSessionName(false)
         .attributeMappings(List.of(AttributeMappingProperty.builder()
                 .certificateField("certificateField")
                 .mappingRules(List.of(MappingRuleProperty.builder()
                         .specifier("specifier")
                         .build()))
                 .build()))
         .durationSeconds(123)
         .enabled(false)
         .managedPolicyArns(List.of("managedPolicyArns"))
         .requireInstanceProperties(false)
         .sessionPolicy("sessionPolicy")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • 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

    • CfnProfile

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

    • CfnProfile

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

    • CfnProfile

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

    • fromProfileArn

      @Stability(Stable) @NotNull public static IProfileRef fromProfileArn(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String arn)
      Creates a new IProfileRef from an ARN.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      arn - This parameter is required.

    • fromProfileId

      @Stability(Stable) @NotNull public static IProfileRef fromProfileId(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String profileId)
      Creates a new IProfileRef from a profileId.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      profileId - This parameter is required.

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

    • getAttrProfileArn

      @Stability(Stable) @NotNull public String getAttrProfileArn()
      The ARN of the profile.

    • getAttrProfileId

      @Stability(Stable) @NotNull public String getAttrProfileId()
      The unique primary identifier of the Profile.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getProfileRef

      @Stability(Stable) @NotNull public ProfileReference getProfileRef()
      A reference to a Profile resource.
      Specified by:
      getProfileRef in interface IProfileRef

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getName

      @Stability(Stable) @NotNull public String getName()
      The customer specified name of the resource.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The customer specified name of the resource.

    • getRoleArns

      @Stability(Stable) @NotNull public List<String> getRoleArns()
      A list of IAM role ARNs that can be assumed when this profile is specified in a CreateSession request.

    • setRoleArns

      @Stability(Stable) public void setRoleArns(@NotNull List<String> value)
      A list of IAM role ARNs that can be assumed when this profile is specified in a CreateSession request.

    • getAcceptRoleSessionName

      @Stability(Stable) @Nullable public Object getAcceptRoleSessionName()
      Used to determine if a custom role session name will be accepted in a temporary credential request.

      Returns union: either Boolean or IResolvable

    • setAcceptRoleSessionName

      @Stability(Stable) public void setAcceptRoleSessionName(@Nullable Boolean value)
      Used to determine if a custom role session name will be accepted in a temporary credential request.

    • setAcceptRoleSessionName

      @Stability(Stable) public void setAcceptRoleSessionName(@Nullable IResolvable value)
      Used to determine if a custom role session name will be accepted in a temporary credential request.

    • getAttributeMappings

      @Stability(Stable) @Nullable public Object getAttributeMappings()
      A mapping applied to the authenticating end-entity certificate.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnProfile.AttributeMappingProperty>

    • setAttributeMappings

      @Stability(Stable) public void setAttributeMappings(@Nullable IResolvable value)
      A mapping applied to the authenticating end-entity certificate.

    • setAttributeMappings

      @Stability(Stable) public void setAttributeMappings(@Nullable List<Object> value)
      A mapping applied to the authenticating end-entity certificate.

    • getDurationSeconds

      @Stability(Stable) @Nullable public Number getDurationSeconds()
      The number of seconds vended session credentials will be valid for.

    • setDurationSeconds

      @Stability(Stable) public void setDurationSeconds(@Nullable Number value)
      The number of seconds vended session credentials will be valid for.

    • getEnabled

      @Stability(Stable) @Nullable public Object getEnabled()
      The enabled status of the resource.

      Returns union: either Boolean or IResolvable

    • setEnabled

      @Stability(Stable) public void setEnabled(@Nullable Boolean value)
      The enabled status of the resource.

    • setEnabled

      @Stability(Stable) public void setEnabled(@Nullable IResolvable value)
      The enabled status of the resource.

    • getManagedPolicyArns

      @Stability(Stable) @Nullable public List<String> getManagedPolicyArns()
      A list of managed policy ARNs.

    • setManagedPolicyArns

      @Stability(Stable) public void setManagedPolicyArns(@Nullable List<String> value)
      A list of managed policy ARNs.

    • getRequireInstanceProperties

      @Stability(Stable) @Nullable public Object getRequireInstanceProperties()
      Specifies whether instance properties are required in CreateSession requests with this profile.

      Returns union: either Boolean or IResolvable

    • setRequireInstanceProperties

      @Stability(Stable) public void setRequireInstanceProperties(@Nullable Boolean value)
      Specifies whether instance properties are required in CreateSession requests with this profile.

    • setRequireInstanceProperties

      @Stability(Stable) public void setRequireInstanceProperties(@Nullable IResolvable value)
      Specifies whether instance properties are required in CreateSession requests with this profile.

    • getSessionPolicy

      @Stability(Stable) @Nullable public String getSessionPolicy()
      A session policy that will applied to the trust boundary of the vended session credentials.

    • setSessionPolicy

      @Stability(Stable) public void setSessionPolicy(@Nullable String value)
      A session policy that will applied to the trust boundary of the vended session credentials.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      A list of Tags.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      A list of Tags.