software.amazon.awscdk.services.licensemanager

Class CfnGrant

java.lang.Object

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

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-28T18:14:34.393Z")
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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnGrant.Builder A fluent builder for CfnGrant.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnGrant(Construct scope, java.lang.String id) Create a new `AWS::LicenseManager::Grant`.
	CfnGrant(Construct scope, java.lang.String id, CfnGrantProps props) Create a new `AWS::LicenseManager::Grant`.
protected	CfnGrant(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnGrant(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.String>	getAllowedOperations() Allowed operations for the grant.
java.lang.String	getAttrGrantArn() The Amazon Resource Name (ARN) of the grant.
java.lang.String	getAttrVersion() The grant version.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getGrantName() Grant name.
java.lang.String	getHomeRegion() Home Region of the grant.
java.lang.String	getLicenseArn() License ARN.
java.util.List<java.lang.String>	getPrincipals() The grant principals.
java.lang.String	getStatus() Granted license status.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setAllowedOperations(java.util.List<java.lang.String> value) Allowed operations for the grant.
void	setGrantName(java.lang.String value) Grant name.
void	setHomeRegion(java.lang.String value) Home Region of the grant.
void	setLicenseArn(java.lang.String value) License ARN.
void	setPrincipals(java.util.List<java.lang.String> value) The grant principals.
void	setStatus(java.lang.String value) Granted license status.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnGrant

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

CfnGrant

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

CfnGrant

public CfnGrant(Construct scope,
                java.lang.String id,
                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

public CfnGrant(Construct scope,
                java.lang.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 Detail

inspect

public void inspect(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

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrGrantArn

public java.lang.String getAttrGrantArn()

The Amazon Resource Name (ARN) of the grant.

getAttrVersion

public java.lang.String getAttrVersion()

The grant version.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getAllowedOperations

public java.util.List<java.lang.String> getAllowedOperations()

Allowed operations for the grant.

setAllowedOperations

public void setAllowedOperations(java.util.List<java.lang.String> value)

Allowed operations for the grant.

getGrantName

public java.lang.String getGrantName()

Grant name.

setGrantName

public void setGrantName(java.lang.String value)

Grant name.

getHomeRegion

public java.lang.String getHomeRegion()

Home Region of the grant.

setHomeRegion

public void setHomeRegion(java.lang.String value)

Home Region of the grant.

getLicenseArn

public java.lang.String getLicenseArn()

License ARN.

setLicenseArn

public void setLicenseArn(java.lang.String value)

License ARN.

getPrincipals

public java.util.List<java.lang.String> getPrincipals()

The grant principals.

setPrincipals

public void setPrincipals(java.util.List<java.lang.String> value)

The grant principals.

getStatus

public java.lang.String getStatus()

Granted license status.

setStatus

public void setStatus(java.lang.String value)

Granted license status.