Class CfnQueuePolicy
The AWS::SQS::QueuePolicy
type applies a policy to Amazon SQS queues.
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.SQS
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnQueuePolicy : CfnResource, IInspectable
Syntax (vb)
Public Class CfnQueuePolicy
Inherits CfnResource
Implements IInspectable
Remarks
For an example snippet, see Declaring an Amazon SQS policy in the AWS CloudFormation User Guide .
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queuepolicy.html
CloudformationResource: AWS::SQS::QueuePolicy
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.SQS;
var policyDocument;
var cfnQueuePolicy = new CfnQueuePolicy(this, "MyCfnQueuePolicy", new CfnQueuePolicyProps {
PolicyDocument = policyDocument,
Queues = new [] { "queues" }
});
Synopsis
Constructors
CfnQueuePolicy(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnQueuePolicy(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnQueuePolicy(Construct, String, ICfnQueuePolicyProps) |
Properties
AttrId | The provider-assigned unique ID for this managed resource. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
PolicyDocument | A policy document that contains the permissions for the specified Amazon SQS queues. |
Queues | The URLs of the queues to which you want to add the policy. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnQueuePolicy(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnQueuePolicy(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnQueuePolicy(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnQueuePolicy(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnQueuePolicy(Construct, String, ICfnQueuePolicyProps)
public CfnQueuePolicy(Construct scope, string id, ICfnQueuePolicyProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnQueuePolicyProps
Resource properties.
Properties
AttrId
The provider-assigned unique ID for this managed resource.
public virtual string AttrId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Id
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
PolicyDocument
A policy document that contains the permissions for the specified Amazon SQS queues.
public virtual object PolicyDocument { get; set; }
Property Value
System.Object
Queues
The URLs of the queues to which you want to add the policy.
public virtual string[] Queues { get; set; }
Property Value
System.String[]
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>