Resource Type definition for AWS::BedrockAgentCore::Policy
Create Policy Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
@overload
def Policy(resource_name: str,
args: PolicyArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Policy(resource_name: str,
opts: Optional[ResourceOptions] = None,
definition: Optional[PolicyDefinitionArgs] = None,
policy_engine_id: Optional[str] = None,
description: Optional[str] = None,
enforcement_mode: Optional[PolicyEnforcementMode] = None,
name: Optional[str] = None,
validation_mode: Optional[PolicyValidationMode] = None)
public Policy(String name, PolicyArgs args)
public Policy(String name, PolicyArgs args, CustomResourceOptions options)
type: aws-native:bedrockagentcore:Policy
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "aws-native_bedrockagentcore_policy" "name" {
# resource properties
}
Parameters
- name
string
- The unique name of the resource.
- args
PolicyArgs
- The arguments to resource properties.
- opts
CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name
str
- The unique name of the resource.
- args
PolicyArgs
- The arguments to resource properties.
- opts
ResourceOptions
- Bag of options to control resource's behavior.
- ctx
Context
- Context object for the current deployment.
- name
string
- The unique name of the resource.
- args
PolicyArgs
- The arguments to resource properties.
- opts
ResourceOption
- Bag of options to control resource's behavior.
- name
string
- The unique name of the resource.
- args
PolicyArgs
- The arguments to resource properties.
- opts
CustomResourceOptions
- Bag of options to control resource's behavior.
- name
String
- The unique name of the resource.
- args
PolicyArgs
- The arguments to resource properties.
- options
CustomResourceOptions
- Bag of options to control resource's behavior.
Policy Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Policy resource accepts the following input properties:
Outputs
All input properties are implicitly available as output properties. Additionally, the Policy resource produces the following output properties:
- CreatedAt
string
- The timestamp when the policy was created.
- Id
string
- The provider-assigned unique ID for this managed resource.
- PolicyArn
string
- The Amazon Resource Name (ARN) of the policy.
- PolicyId
string
- The unique identifier for the policy.
- Status
PolicyStatus
- The current status of the policy.
- StatusReasons
[]string
- Additional information about the policy status.
- UpdatedAt
string
- The timestamp when the policy was last updated.
- createdAt
String
- The timestamp when the policy was created.
- id
String
- The provider-assigned unique ID for this managed resource.
- policyArn
String
- The Amazon Resource Name (ARN) of the policy.
- policyId
String
- The unique identifier for the policy.
- status
PolicyStatus
- The current status of the policy.
- statusReasons
List<String>
- Additional information about the policy status.
- updatedAt
String
- The timestamp when the policy was last updated.
- createdAt
string
- The timestamp when the policy was created.
- id
string
- The provider-assigned unique ID for this managed resource.
- policyArn
string
- The Amazon Resource Name (ARN) of the policy.
- policyId
string
- The unique identifier for the policy.
- status
PolicyStatus
- The current status of the policy.
- statusReasons
string[]
- Additional information about the policy status.
- updatedAt
string
- The timestamp when the policy was last updated.
- created_at
str
- The timestamp when the policy was created.
- id
str
- The provider-assigned unique ID for this managed resource.
- policy_arn
str
- The Amazon Resource Name (ARN) of the policy.
- policy_id
str
- The unique identifier for the policy.
- status
PolicyStatus
- The current status of the policy.
- status_reasons
Sequence[str]
- Additional information about the policy status.
- updated_at
str
- The timestamp when the policy was last updated.
Look up Existing Policy Resource
Get an existing Policy resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static Policy get(String name, Output<String> id, CustomResourceOptions options)
resources: existingPolicy: type: aws-native:bedrockagentcore:Policy get: id: ${id}
import {
to = aws-native_bedrockagentcore_policy.example
id = "${id}"
}
- name
string
- The unique name of the resulting resource.
- id
Input<ID>
- The unique provider ID of the resource to look up.
- opts
CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name
str
- The unique name of the resulting resource.
- id
str
- The unique provider ID of the resource to look up.
- opts
ResourceOptions
- Bag of options to control resource's behavior.
- ctx
Context
- Context object for the current deployment.
- name
string
- The unique name of the resulting resource.
- id
IDInput
- The unique provider ID of the resource to look up.
- state
PolicyState
- Pass nil. This resource has no state arguments.
- opts
ResourceOption
- Bag of options to control resource's behavior.
- name
string
- The unique name of the resulting resource.
- id
Input<string>
- The unique provider ID of the resource to look up.
- opts
CustomResourceOptions
- Bag of options to control resource's behavior.
- name
String
- The unique name of the resulting resource.
- id
Output<String>
- The unique provider ID of the resource to look up.
- options
CustomResourceOptions
- Bag of options to control resource's behavior.
Supporting Types
PolicyCedarPolicy, PolicyCedarPolicyArgs
A Cedar policy statement within the AgentCore Policy system.
- Statement
string
- The Cedar policy statement that defines the authorization logic.
- Statement
string
- The Cedar policy statement that defines the authorization logic.
- statement
string
- The Cedar policy statement that defines the authorization logic.
- statement
String
- The Cedar policy statement that defines the authorization logic.
- statement
string
- The Cedar policy statement that defines the authorization logic.
- statement
str
- The Cedar policy statement that defines the authorization logic.
- statement
String
- The Cedar policy statement that defines the authorization logic.
PolicyDefinition, PolicyDefinitionArgs
The definition structure for policies. Encapsulates different policy formats.
PolicyEnforcementMode
Whether the policy contributes to the enforce decision returned to Gateway. LOG_ONLY policies are still evaluated but their decisions are observed only, allowing customers to validate a policy against real traffic before promoting it.
| Name | Value |
|---|
| Active | ACTIVE |
| LogOnly | LOG_ONLY |
| Name | Value |
|---|
| PolicyEnforcementModeActive | ACTIVE |
| PolicyEnforcementModeLogOnly | LOG_ONLY |
| Name | Value |
|---|
| Active | ACTIVE |
| LogOnly | LOG_ONLY |
| Name | Value |
|---|
| Active | ACTIVE |
| LogOnly | LOG_ONLY |
| Name | Value |
|---|
| ACTIVE | ACTIVE |
| LOG_ONLY | LOG_ONLY |
PolicyStatement, PolicyStatementArgs
A policy statement within the AgentCore Policy system.
PolicyStatus
| Name | Value |
|---|
| Creating | CREATING |
| Active | ACTIVE |
| Updating | UPDATING |
| Deleting | DELETING |
| CreateFailed | CREATE_FAILED |
| UpdateFailed | UPDATE_FAILED |
| DeleteFailed | DELETE_FAILED |
| Name | Value |
|---|
| PolicyStatusCreating | CREATING |
| PolicyStatusActive | ACTIVE |
| PolicyStatusUpdating | UPDATING |
| PolicyStatusDeleting | DELETING |
| PolicyStatusCreateFailed | CREATE_FAILED |
| PolicyStatusUpdateFailed | UPDATE_FAILED |
| PolicyStatusDeleteFailed | DELETE_FAILED |
| Value |
|---|
CREATING |
ACTIVE |
UPDATING |
DELETING |
CREATE_FAILED |
UPDATE_FAILED |
DELETE_FAILED |
| Name | Value |
|---|
| Creating | CREATING |
| Active | ACTIVE |
| Updating | UPDATING |
| Deleting | DELETING |
| CreateFailed | CREATE_FAILED |
| UpdateFailed | UPDATE_FAILED |
| DeleteFailed | DELETE_FAILED |
| Name | Value |
|---|
| Creating | CREATING |
| Active | ACTIVE |
| Updating | UPDATING |
| Deleting | DELETING |
| CreateFailed | CREATE_FAILED |
| UpdateFailed | UPDATE_FAILED |
| DeleteFailed | DELETE_FAILED |
| Name | Value |
|---|
| CREATING | CREATING |
| ACTIVE | ACTIVE |
| UPDATING | UPDATING |
| DELETING | DELETING |
| CREATE_FAILED | CREATE_FAILED |
| UPDATE_FAILED | UPDATE_FAILED |
| DELETE_FAILED | DELETE_FAILED |
| Value |
|---|
CREATING |
ACTIVE |
UPDATING |
DELETING |
CREATE_FAILED |
UPDATE_FAILED |
DELETE_FAILED |
PolicyValidationMode
The validation mode for the policy. Determines how Cedar analyzer validation results are handled.
| Name | Value |
|---|
| FailOnAnyFindings | FAIL_ON_ANY_FINDINGS |
| IgnoreAllFindings | IGNORE_ALL_FINDINGS |
| Name | Value |
|---|
| PolicyValidationModeFailOnAnyFindings | FAIL_ON_ANY_FINDINGS |
| PolicyValidationModeIgnoreAllFindings | IGNORE_ALL_FINDINGS |
| Value |
|---|
FAIL_ON_ANY_FINDINGS |
IGNORE_ALL_FINDINGS |
| Name | Value |
|---|
| FailOnAnyFindings | FAIL_ON_ANY_FINDINGS |
| IgnoreAllFindings | IGNORE_ALL_FINDINGS |
| Name | Value |
|---|
| FailOnAnyFindings | FAIL_ON_ANY_FINDINGS |
| IgnoreAllFindings | IGNORE_ALL_FINDINGS |
| Name | Value |
|---|
| FAIL_ON_ANY_FINDINGS | FAIL_ON_ANY_FINDINGS |
| IGNORE_ALL_FINDINGS | IGNORE_ALL_FINDINGS |
| Value |
|---|
FAIL_ON_ANY_FINDINGS |
IGNORE_ALL_FINDINGS |
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0