Package software.amazon.awscdk.services.licensemanager

Class CfnGrant

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.licensemanager.CfnGrant
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:29:59.682Z") @Stability(Stable) public class CfnGrant extends CfnResource implements IInspectable
A CloudFormation AWS::LicenseManager::Grant.

Specifies a grant.

A grant shares the use of license entitlements with specific AWS accounts . For more information, see Granted licenses in the AWS License Manager 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.licensemanager.*;
 CfnGrant cfnGrant = CfnGrant.Builder.create(this, "MyCfnGrant")
         .allowedOperations(List.of("allowedOperations"))
         .grantName("grantName")
         .homeRegion("homeRegion")
         .licenseArn("licenseArn")
         .principals(List.of("principals"))
         .status("status")
         .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

    • CfnGrant

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

    • CfnGrant

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

    • CfnGrant

      @Stability(Stable) public CfnGrant(@NotNull Construct scope, @NotNull String id, @Nullable CfnGrantProps props)
      Create a new AWS::LicenseManager::Grant.

      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.

    • CfnGrant

      @Stability(Stable) public CfnGrant(@NotNull Construct scope, @NotNull String id)
      Create a new AWS::LicenseManager::Grant.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      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.

    • getAttrGrantArn

      @Stability(Stable) @NotNull public String getAttrGrantArn()
      The Amazon Resource Name (ARN) of the grant.

    • getAttrVersion

      @Stability(Stable) @NotNull public String getAttrVersion()
      The grant version.

    • getCfnProperties

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

    • getAllowedOperations

      @Stability(Stable) @Nullable public List<String> getAllowedOperations()
      Allowed operations for the grant.

    • setAllowedOperations

      @Stability(Stable) public void setAllowedOperations(@Nullable List<String> value)
      Allowed operations for the grant.

    • getGrantName

      @Stability(Stable) @Nullable public String getGrantName()
      Grant name.

    • setGrantName

      @Stability(Stable) public void setGrantName(@Nullable String value)
      Grant name.

    • getHomeRegion

      @Stability(Stable) @Nullable public String getHomeRegion()
      Home Region of the grant.

    • setHomeRegion

      @Stability(Stable) public void setHomeRegion(@Nullable String value)
      Home Region of the grant.

    • getLicenseArn

      @Stability(Stable) @Nullable public String getLicenseArn()
      License ARN.

    • setLicenseArn

      @Stability(Stable) public void setLicenseArn(@Nullable String value)
      License ARN.

    • getPrincipals

      @Stability(Stable) @Nullable public List<String> getPrincipals()
      The grant principals. You can specify one of the following as an Amazon Resource Name (ARN):.

      • An AWS account, which includes only the account specified.
      • An organizational unit (OU), which includes all accounts in the OU.
      • An organization, which will include all accounts across your organization.

    • setPrincipals

      @Stability(Stable) public void setPrincipals(@Nullable List<String> value)
      The grant principals. You can specify one of the following as an Amazon Resource Name (ARN):.

      • An AWS account, which includes only the account specified.
      • An organizational unit (OU), which includes all accounts in the OU.
      • An organization, which will include all accounts across your organization.

    • getStatus

      @Stability(Stable) @Nullable public String getStatus()
      Granted license status.

    • setStatus

      @Stability(Stable) public void setStatus(@Nullable String value)
      Granted license status.