Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. s3control
  5. MultiRegionAccessPointPolicy
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

aws.s3control.MultiRegionAccessPointPolicy

Explore with Pulumi AI

aws logo
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

    Provides a resource to manage an S3 Multi-Region Access Point access control policy.

    Example Usage

    Create MultiRegionAccessPointPolicy Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new MultiRegionAccessPointPolicy(name: string, args: MultiRegionAccessPointPolicyArgs, opts?: CustomResourceOptions);
    @overload
def MultiRegionAccessPointPolicy(resource_name: str,
                                 args: MultiRegionAccessPointPolicyArgs,
                                 opts: Optional[ResourceOptions] = None)

@overload
def MultiRegionAccessPointPolicy(resource_name: str,
                                 opts: Optional[ResourceOptions] = None,
                                 details: Optional[MultiRegionAccessPointPolicyDetailsArgs] = None,
                                 account_id: Optional[str] = None)
    func NewMultiRegionAccessPointPolicy(ctx *Context, name string, args MultiRegionAccessPointPolicyArgs, opts ...ResourceOption) (*MultiRegionAccessPointPolicy, error)
    public MultiRegionAccessPointPolicy(string name, MultiRegionAccessPointPolicyArgs args, CustomResourceOptions? opts = null)
    public MultiRegionAccessPointPolicy(String name, MultiRegionAccessPointPolicyArgs args)
public MultiRegionAccessPointPolicy(String name, MultiRegionAccessPointPolicyArgs args, CustomResourceOptions options)

    type: aws:s3control:MultiRegionAccessPointPolicy
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args MultiRegionAccessPointPolicyArgs
    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 MultiRegionAccessPointPolicyArgs
    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 MultiRegionAccessPointPolicyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args MultiRegionAccessPointPolicyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args MultiRegionAccessPointPolicyArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var multiRegionAccessPointPolicyResource = new Aws.S3Control.MultiRegionAccessPointPolicy("multiRegionAccessPointPolicyResource", new()
{
    Details = new Aws.S3Control.Inputs.MultiRegionAccessPointPolicyDetailsArgs
    {
        Name = "string",
        Policy = "string",
    },
    AccountId = "string",
});

    example, err := s3control.NewMultiRegionAccessPointPolicy(ctx, "multiRegionAccessPointPolicyResource", &s3control.MultiRegionAccessPointPolicyArgs{
	Details: &s3control.MultiRegionAccessPointPolicyDetailsArgs{
		Name:   pulumi.String("string"),
		Policy: pulumi.String("string"),
	},
	AccountId: pulumi.String("string"),
})

    var multiRegionAccessPointPolicyResource = new MultiRegionAccessPointPolicy("multiRegionAccessPointPolicyResource", MultiRegionAccessPointPolicyArgs.builder()
    .details(MultiRegionAccessPointPolicyDetailsArgs.builder()
        .name("string")
        .policy("string")
        .build())
    .accountId("string")
    .build());

    multi_region_access_point_policy_resource = aws.s3control.MultiRegionAccessPointPolicy("multiRegionAccessPointPolicyResource",
    details={
        "name": "string",
        "policy": "string",
    },
    account_id="string")

    const multiRegionAccessPointPolicyResource = new aws.s3control.MultiRegionAccessPointPolicy("multiRegionAccessPointPolicyResource", {
    details: {
        name: "string",
        policy: "string",
    },
    accountId: "string",
});

    type: aws:s3control:MultiRegionAccessPointPolicy
properties:
    accountId: string
    details:
        name: string
        policy: string

    MultiRegionAccessPointPolicy Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The MultiRegionAccessPointPolicy resource accepts the following input properties:

    Details MultiRegionAccessPointPolicyDetails
    A configuration block containing details about the policy for the Multi-Region Access Point. See Details Configuration Block below for more details
    AccountId string
    The AWS account ID for the owner of the Multi-Region Access Point. Defaults to automatically determined account ID of the AWS provider.
    Details MultiRegionAccessPointPolicyDetailsArgs
    A configuration block containing details about the policy for the Multi-Region Access Point. See Details Configuration Block below for more details
    AccountId string
    The AWS account ID for the owner of the Multi-Region Access Point. Defaults to automatically determined account ID of the AWS provider.
    details MultiRegionAccessPointPolicyDetails
    A configuration block containing details about the policy for the Multi-Region Access Point. See Details Configuration Block below for more details
    accountId String
    The AWS account ID for the owner of the Multi-Region Access Point. Defaults to automatically determined account ID of the AWS provider.
    details MultiRegionAccessPointPolicyDetails
    A configuration block containing details about the policy for the Multi-Region Access Point. See Details Configuration Block below for more details
    accountId string
    The AWS account ID for the owner of the Multi-Region Access Point. Defaults to automatically determined account ID of the AWS provider.
    details MultiRegionAccessPointPolicyDetailsArgs
    A configuration block containing details about the policy for the Multi-Region Access Point. See Details Configuration Block below for more details
    account_id str
    The AWS account ID for the owner of the Multi-Region Access Point. Defaults to automatically determined account ID of the AWS provider.
    details Property Map
    A configuration block containing details about the policy for the Multi-Region Access Point. See Details Configuration Block below for more details
    accountId String
    The AWS account ID for the owner of the Multi-Region Access Point. Defaults to automatically determined account ID of the AWS provider.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the MultiRegionAccessPointPolicy resource produces the following output properties:

    Established string
    The last established policy for the Multi-Region Access Point.
    Id string
    The provider-assigned unique ID for this managed resource.
    Proposed string
    The proposed policy for the Multi-Region Access Point.
    Established string
    The last established policy for the Multi-Region Access Point.
    Id string
    The provider-assigned unique ID for this managed resource.
    Proposed string
    The proposed policy for the Multi-Region Access Point.
    established String
    The last established policy for the Multi-Region Access Point.
    id String
    The provider-assigned unique ID for this managed resource.
    proposed String
    The proposed policy for the Multi-Region Access Point.
    established string
    The last established policy for the Multi-Region Access Point.
    id string
    The provider-assigned unique ID for this managed resource.
    proposed string
    The proposed policy for the Multi-Region Access Point.
    established str
    The last established policy for the Multi-Region Access Point.
    id str
    The provider-assigned unique ID for this managed resource.
    proposed str
    The proposed policy for the Multi-Region Access Point.
    established String
    The last established policy for the Multi-Region Access Point.
    id String
    The provider-assigned unique ID for this managed resource.
    proposed String
    The proposed policy for the Multi-Region Access Point.

    Look up Existing MultiRegionAccessPointPolicy Resource

    Get an existing MultiRegionAccessPointPolicy resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: MultiRegionAccessPointPolicyState, opts?: CustomResourceOptions): MultiRegionAccessPointPolicy
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_id: Optional[str] = None,
        details: Optional[MultiRegionAccessPointPolicyDetailsArgs] = None,
        established: Optional[str] = None,
        proposed: Optional[str] = None) -> MultiRegionAccessPointPolicy
    func GetMultiRegionAccessPointPolicy(ctx *Context, name string, id IDInput, state *MultiRegionAccessPointPolicyState, opts ...ResourceOption) (*MultiRegionAccessPointPolicy, error)
    public static MultiRegionAccessPointPolicy Get(string name, Input<string> id, MultiRegionAccessPointPolicyState? state, CustomResourceOptions? opts = null)
    public static MultiRegionAccessPointPolicy get(String name, Output<String> id, MultiRegionAccessPointPolicyState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AccountId string
    The AWS account ID for the owner of the Multi-Region Access Point. Defaults to automatically determined account ID of the AWS provider.
    Details MultiRegionAccessPointPolicyDetails
    A configuration block containing details about the policy for the Multi-Region Access Point. See Details Configuration Block below for more details
    Established string
    The last established policy for the Multi-Region Access Point.
    Proposed string
    The proposed policy for the Multi-Region Access Point.
    AccountId string
    The AWS account ID for the owner of the Multi-Region Access Point. Defaults to automatically determined account ID of the AWS provider.
    Details MultiRegionAccessPointPolicyDetailsArgs
    A configuration block containing details about the policy for the Multi-Region Access Point. See Details Configuration Block below for more details
    Established string
    The last established policy for the Multi-Region Access Point.
    Proposed string
    The proposed policy for the Multi-Region Access Point.
    accountId String
    The AWS account ID for the owner of the Multi-Region Access Point. Defaults to automatically determined account ID of the AWS provider.
    details MultiRegionAccessPointPolicyDetails
    A configuration block containing details about the policy for the Multi-Region Access Point. See Details Configuration Block below for more details
    established String
    The last established policy for the Multi-Region Access Point.
    proposed String
    The proposed policy for the Multi-Region Access Point.
    accountId string
    The AWS account ID for the owner of the Multi-Region Access Point. Defaults to automatically determined account ID of the AWS provider.
    details MultiRegionAccessPointPolicyDetails
    A configuration block containing details about the policy for the Multi-Region Access Point. See Details Configuration Block below for more details
    established string
    The last established policy for the Multi-Region Access Point.
    proposed string
    The proposed policy for the Multi-Region Access Point.
    account_id str
    The AWS account ID for the owner of the Multi-Region Access Point. Defaults to automatically determined account ID of the AWS provider.
    details MultiRegionAccessPointPolicyDetailsArgs
    A configuration block containing details about the policy for the Multi-Region Access Point. See Details Configuration Block below for more details
    established str
    The last established policy for the Multi-Region Access Point.
    proposed str
    The proposed policy for the Multi-Region Access Point.
    accountId String
    The AWS account ID for the owner of the Multi-Region Access Point. Defaults to automatically determined account ID of the AWS provider.
    details Property Map
    A configuration block containing details about the policy for the Multi-Region Access Point. See Details Configuration Block below for more details
    established String
    The last established policy for the Multi-Region Access Point.
    proposed String
    The proposed policy for the Multi-Region Access Point.

    Supporting Types

    MultiRegionAccessPointPolicyDetails, MultiRegionAccessPointPolicyDetailsArgs

    Name string
    The name of the Multi-Region Access Point.
    Policy string

    A valid JSON document that specifies the policy that you want to associate with this Multi-Region Access Point. Once applied, the policy can be edited, but not deleted. For more information, see the documentation on Multi-Region Access Point Permissions.

    NOTE: When you update the policy, the update is first listed as the proposed policy. After the update is finished and all Regions have been updated, the proposed policy is listed as the established policy. If both policies have the same version number, the proposed policy is the established policy.

    Name string
    The name of the Multi-Region Access Point.
    Policy string

    A valid JSON document that specifies the policy that you want to associate with this Multi-Region Access Point. Once applied, the policy can be edited, but not deleted. For more information, see the documentation on Multi-Region Access Point Permissions.

    NOTE: When you update the policy, the update is first listed as the proposed policy. After the update is finished and all Regions have been updated, the proposed policy is listed as the established policy. If both policies have the same version number, the proposed policy is the established policy.

    name String
    The name of the Multi-Region Access Point.
    policy String

    A valid JSON document that specifies the policy that you want to associate with this Multi-Region Access Point. Once applied, the policy can be edited, but not deleted. For more information, see the documentation on Multi-Region Access Point Permissions.

    NOTE: When you update the policy, the update is first listed as the proposed policy. After the update is finished and all Regions have been updated, the proposed policy is listed as the established policy. If both policies have the same version number, the proposed policy is the established policy.

    name string
    The name of the Multi-Region Access Point.
    policy string

    A valid JSON document that specifies the policy that you want to associate with this Multi-Region Access Point. Once applied, the policy can be edited, but not deleted. For more information, see the documentation on Multi-Region Access Point Permissions.

    NOTE: When you update the policy, the update is first listed as the proposed policy. After the update is finished and all Regions have been updated, the proposed policy is listed as the established policy. If both policies have the same version number, the proposed policy is the established policy.

    name str
    The name of the Multi-Region Access Point.
    policy str

    A valid JSON document that specifies the policy that you want to associate with this Multi-Region Access Point. Once applied, the policy can be edited, but not deleted. For more information, see the documentation on Multi-Region Access Point Permissions.

    NOTE: When you update the policy, the update is first listed as the proposed policy. After the update is finished and all Regions have been updated, the proposed policy is listed as the established policy. If both policies have the same version number, the proposed policy is the established policy.

    name String
    The name of the Multi-Region Access Point.
    policy String

    A valid JSON document that specifies the policy that you want to associate with this Multi-Region Access Point. Once applied, the policy can be edited, but not deleted. For more information, see the documentation on Multi-Region Access Point Permissions.

    NOTE: When you update the policy, the update is first listed as the proposed policy. After the update is finished and all Regions have been updated, the proposed policy is listed as the established policy. If both policies have the same version number, the proposed policy is the established policy.

    Import

    Using pulumi import, import Multi-Region Access Point Policies using the account_id and name of the Multi-Region Access Point separated by a colon (:). For example:

    $ pulumi import aws:s3control/multiRegionAccessPointPolicy:MultiRegionAccessPointPolicy example 123456789012:example

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
    pulumi/pulumi-aws