Class CfnAuthPolicy
A CloudFormation AWS::VpcLattice::AuthPolicy
.
Inherited Members
Namespace: Amazon.CDK.AWS.VpcLattice
Assembly: Amazon.CDK.AWS.VpcLattice.dll
Syntax (csharp)
public class CfnAuthPolicy : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnAuthPolicy
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
Creates or updates the auth policy. The policy string in JSON must not contain newlines or blank lines.
CloudformationResource: AWS::VpcLattice::AuthPolicy
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.VpcLattice;
var policy;
var cfnAuthPolicy = new CfnAuthPolicy(this, "MyCfnAuthPolicy", new CfnAuthPolicyProps {
Policy = policy,
ResourceIdentifier = "resourceIdentifier"
});
Synopsis
Constructors
CfnAuthPolicy(Construct, String, ICfnAuthPolicyProps) | Create a new |
CfnAuthPolicy(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnAuthPolicy(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AttrState | The state of the auth policy. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Policy | The auth policy. |
ResourceIdentifier | The ID or Amazon Resource Name (ARN) of the service network or service for which the policy is created. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnAuthPolicy(Construct, String, ICfnAuthPolicyProps)
Create a new AWS::VpcLattice::AuthPolicy
.
public CfnAuthPolicy(Construct scope, string id, ICfnAuthPolicyProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnAuthPolicyProps
- resource properties.
CfnAuthPolicy(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnAuthPolicy(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnAuthPolicy(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnAuthPolicy(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AttrState
The state of the auth policy.
public virtual string AttrState { get; }
Property Value
System.String
Remarks
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 is NONE
, then any auth policy you provide will remain inactive.
CloudformationAttribute: State
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Policy
The auth policy.
public virtual object Policy { get; set; }
Property Value
System.Object
Remarks
ResourceIdentifier
The ID or Amazon Resource Name (ARN) of the service network or service for which the policy is created.
public virtual string ResourceIdentifier { get; set; }
Property Value
System.String
Remarks
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>