Class CfnAuthPolicy
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.vpclattice.CfnAuthPolicy
- All Implemented Interfaces:
IInspectable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
date="2024-11-21T06:34:17.170Z")
@Stability(Stable)
public class CfnAuthPolicy
extends CfnResource
implements IInspectable
Creates or updates the auth policy. The policy string in JSON must not contain newlines or blank lines.
For more information, see Auth policies in the Amazon VPC Lattice 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.vpclattice.*; Object policy; CfnAuthPolicy cfnAuthPolicy = CfnAuthPolicy.Builder.create(this, "MyCfnAuthPolicy") .policy(policy) .resourceIdentifier("resourceIdentifier") .build();
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionprotected
CfnAuthPolicy
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnAuthPolicy
(software.amazon.jsii.JsiiObjectRef objRef) CfnAuthPolicy
(software.constructs.Construct scope, String id, CfnAuthPolicyProps props) -
Method Summary
Modifier and TypeMethodDescriptionThe state of the auth policy.The auth policy.The ID or Amazon Resource Name (ARN) of the service network or service for which the policy is created.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
The auth policy.void
setResourceIdentifier
(String value) The ID or Amazon Resource Name (ARN) of the service network or service for which the policy is created.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties
Methods inherited from class software.amazon.awscdk.CfnRefElement
getRef
Methods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
Methods inherited from class software.constructs.Construct
getNode, isConstruct
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnAuthPolicy
protected CfnAuthPolicy(software.amazon.jsii.JsiiObjectRef objRef) -
CfnAuthPolicy
protected CfnAuthPolicy(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnAuthPolicy
@Stability(Stable) public CfnAuthPolicy(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnAuthPolicyProps 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
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- 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 classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrState
The state of the auth policy.The auth policy is only active when the auth type is set to
AWS _IAM
. If you provide a policy, then authentication and authorization decisions are made based on this policy and the client's IAM policy. If the auth type isNONE
, then any auth policy you provide will remain inactive. -
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getPolicy
The auth policy. -
setPolicy
The auth policy. -
getResourceIdentifier
The ID or Amazon Resource Name (ARN) of the service network or service for which the policy is created. -
setResourceIdentifier
The ID or Amazon Resource Name (ARN) of the service network or service for which the policy is created.
-