Class CfnQueuePolicy
A CloudFormation AWS::SQS::QueuePolicy
.
Inherited Members
Namespace: Amazon.CDK.AWS.SQS
Assembly: Amazon.CDK.AWS.SQS.dll
Syntax (csharp)
public class CfnQueuePolicy : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnQueuePolicy
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
The AWS::SQS::QueuePolicy
type applies a policy to Amazon SQS queues. For an example snippet, see Declaring an Amazon SQS policy in the AWS CloudFormation User Guide .
CloudformationResource: AWS::SQS::QueuePolicy
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-policy.html
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(Construct, String, ICfnQueuePolicyProps) | Create a new |
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 |
Properties
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(Construct, String, ICfnQueuePolicyProps)
Create a new AWS::SQS::QueuePolicy
.
public CfnQueuePolicy(Construct scope, string id, ICfnQueuePolicyProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnQueuePolicyProps
- resource properties.
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
Properties
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
Remarks
For more information about Amazon SQS policies, see Using custom policies with the Amazon SQS access policy language in the Amazon SQS Developer Guide .
Queues
The URLs of the queues to which you want to add the policy.
public virtual string[] Queues { get; set; }
Property Value
System.String[]
Remarks
You can use the Ref
function to specify an AWS::SQS::Queue
resource.
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>