put-domain-permissions-policy¶

Description¶

Sets a resource policy on a domain that specifies permissions to access it.

When you call PutDomainPermissionsPolicy , the resource policy on the domain is ignored when evaluting permissions. This ensures that the owner of a domain cannot lock themselves out of the domain, which would prevent them from being able to update the resource policy.

Synopsis¶

  put-domain-permissions-policy
--domain <value>
[--domain-owner <value>]
[--policy-revision <value>]
--policy-document <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--domain (string)

The name of the domain on which to set the resource policy.

--domain-owner (string)

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

--policy-revision (string)

The current revision of the resource policy to be set. This revision is used for optimistic locking, which prevents others from overwriting your changes to the domain’s resource policy.

--policy-document (string)

A valid displayable JSON Aspen policy string to be set as the access control resource policy on the provided domain.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples¶

To attach a permissions policy to a domain

The following put-domain-permissions-policy example attaches a permission policy that is defined in the policy.json file to a domain named test-domain.

aws codeartifact put-domain-permissions-policy \
    --domain test-domain \
    --policy-document file://PATH/TO/policy.json

Output:

{
    "policy": {
        "resourceArn": "arn:aws:codeartifact:region-id:111122223333:domain/test-domain",
        "document": "{ ...policy document content...}",
        "revision": "MQlyyTQRASRU3HB58gBtSDHXG7Q3hvxxxxxxx="
    }
}

For more information, see Set a domain policy in the AWS CodeArtifact User Guide.

Output¶

policy -> (structure)

The resource policy that was set after processing the request.

resourceArn -> (string)

The ARN of the resource associated with the resource policy

revision -> (string)

The current revision of the resource policy.

document -> (string)

The resource policy formatted in JSON.

Table of Contents

Feedback

User Guide