IApplication

class aws_cdk.aws_servicecatalogappregistry_alpha.IApplication(*args, **kwargs)

Bases: IResource, Protocol

(experimental) A Service Catalog AppRegistry Application.

Stability:

experimental

Methods

add_attribute_group(id, *, attribute_group_name, attributes, description=None)

(experimental) Create an attribute group and associate this application with the created attribute group.

Parameters:

  • id (str) – name of the AttributeGroup construct to be created.

  • attribute_group_name (str) – (experimental) Name for attribute group.

  • attributes (Mapping[str, Any]) – (experimental) A JSON of nested key-value pairs that represent the attributes in the group. Attributes maybe an empty JSON ‘{}’, but must be explicitly stated.

  • description (Optional[str]) – (experimental) Description for attribute group. Default: - No description provided

Stability:

experimental

Return type:

IAttributeGroup

apply_removal_policy(policy)

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters:

policy (RemovalPolicy) –

Return type:

None

associate_all_stacks_in_scope(construct)

(experimental) Associate this application with all stacks under the construct node.

NOTE: This method won’t automatically register stacks under pipeline stages, and requires association of each pipeline stage by calling this method with stage Construct.

Parameters:

construct (Construct) – cdk Construct.

Stability:

experimental

Return type:

None

associate_application_with_stack(stack)

(experimental) Associate a Cloudformation statck with the application in the given stack.

Parameters:

stack (Stack) – a CFN stack.

Stability:

experimental

Return type:

None

associate_attribute_group(attribute_group)

(experimental) Associate this application with an attribute group.

Parameters:

attribute_group (IAttributeGroup) – AppRegistry attribute group.

Stability:

experimental

Return type:

None

associate_stack(stack)

(deprecated) Associate this application with a CloudFormation stack.

Parameters:

stack (Stack) – a CFN stack.

Deprecated:

Use associateApplicationWithStack instead.

Stability:

deprecated

Return type:

None

share_application(id, *, name, accounts=None, organization_arns=None, roles=None, share_permission=None, users=None)

(experimental) Share this application with other IAM entities, accounts, or OUs.

Parameters:

  • id (str) – The construct name for the share.

  • name (str) – (experimental) Name of the share.

  • accounts (Optional[Sequence[str]]) – (experimental) A list of AWS accounts that the application will be shared with. Default: - No accounts specified for share

  • organization_arns (Optional[Sequence[str]]) – (experimental) A list of AWS Organization or Organizational Units (OUs) ARNs that the application will be shared with. Default: - No AWS Organizations or OUs specified for share

  • roles (Optional[Sequence[IRole]]) – (experimental) A list of AWS IAM roles that the application will be shared with. Default: - No IAM roles specified for share

  • share_permission (Union[str, SharePermission, None]) – (experimental) An option to manage access to the application or attribute group. Default: - Principals will be assigned read only permissions on the application or attribute group.

  • users (Optional[Sequence[IUser]]) – (experimental) A list of AWS IAM users that the application will be shared with. Default: - No IAM Users specified for share

Stability:

experimental

Return type:

None

Attributes

application_arn

(experimental) The ARN of the application.

Stability:

experimental

Attribute:

true

application_id

(experimental) The ID of the application.

Stability:

experimental

Attribute:

true

application_name

(experimental) The name of the application.

Stability:

experimental

Attribute:

true

env

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

node

The tree node.

stack

The stack in which this resource is defined.