Package software.amazon.awscdk.services.mpa

Class CfnIdentitySource

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.mpa.CfnIdentitySource
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IIdentitySourceRef, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)", date="2025-12-01T16:02:24.877Z") @Stability(Stable) public class CfnIdentitySource extends CfnResource implements IInspectable, IIdentitySourceRef, ITaggableV2
Creates a new identity source.

For more information, see Identity Source in the Multi-party approval User Guide .

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.mpa.*;
 CfnIdentitySource cfnIdentitySource = CfnIdentitySource.Builder.create(this, "MyCfnIdentitySource")
         .identitySourceParameters(IdentitySourceParametersProperty.builder()
                 .iamIdentityCenter(IamIdentityCenterProperty.builder()
                         .instanceArn("instanceArn")
                         .region("region")
                         // the properties below are optional
                         .approvalPortalUrl("approvalPortalUrl")
                         .build())
                 .build())
         // the properties below are optional
         .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

    • CfnIdentitySource

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

    • CfnIdentitySource

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

    • CfnIdentitySource

      @Stability(Stable) public CfnIdentitySource(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnIdentitySourceProps props)
      Create a new AWS::MPA::IdentitySource.

      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

    • arnForIdentitySource

      @Stability(Stable) @NotNull public static String arnForIdentitySource(@NotNull IIdentitySourceRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnIdentitySource

      @Stability(Stable) @NotNull public static Boolean isCfnIdentitySource(@NotNull Object x)
      Checks whether the given object is a CfnIdentitySource.

      Parameters:
      x - 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.

    • getAttrCreationTime

      @Stability(Stable) @NotNull public String getAttrCreationTime()
      Timestamp when the identity source was created.

    • getAttrIdentitySourceArn

      @Stability(Stable) @NotNull public String getAttrIdentitySourceArn()
      Amazon Resource Name (ARN) for the identity source.

    • getAttrIdentitySourceParametersIamIdentityCenterApprovalPortalUrl

      @Stability(Stable) @NotNull public String getAttrIdentitySourceParametersIamIdentityCenterApprovalPortalUrl()
      URL for the approval portal associated with the IAM Identity Center instance.

    • getAttrIdentitySourceType

      @Stability(Stable) @NotNull public String getAttrIdentitySourceType()
      The type of resource that provided identities to the identity source.

      For example, an IAM Identity Center instance.

    • getAttrStatus

      @Stability(Stable) @NotNull public String getAttrStatus()
      Status for the identity source.

      For example, if the identity source is ACTIVE .

    • getAttrStatusCode

      @Stability(Stable) @NotNull public String getAttrStatusCode()
      Status code of the identity source.

    • getAttrStatusMessage

      @Stability(Stable) @NotNull public String getAttrStatusMessage()
      Message describing the status for the identity source.

    • getCdkTagManager

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

    • getCfnProperties

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

    • getIdentitySourceRef

      @Stability(Stable) @NotNull public IdentitySourceReference getIdentitySourceRef()
      A reference to a IdentitySource resource.
      Specified by:
      getIdentitySourceRef in interface IIdentitySourceRef

    • getIdentitySourceParameters

      @Stability(Stable) @NotNull public Object getIdentitySourceParameters()
      A IdentitySourceParameters object.

      Returns union: either IResolvable or CfnIdentitySource.IdentitySourceParametersProperty

    • setIdentitySourceParameters

      @Stability(Stable) public void setIdentitySourceParameters(@NotNull IResolvable value)
      A IdentitySourceParameters object.

    • setIdentitySourceParameters

      @Stability(Stable) public void setIdentitySourceParameters(@NotNull CfnIdentitySource.IdentitySourceParametersProperty value)
      A IdentitySourceParameters object.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      Tags that you have added to the specified resource.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      Tags that you have added to the specified resource.