amazonka-codeartifact-2.0: Amazon CodeArtifact SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.CodeArtifact.PutDomainPermissionsPolicy

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

Creating a Request

data PutDomainPermissionsPolicy Source #

See: newPutDomainPermissionsPolicy smart constructor.

Constructors

PutDomainPermissionsPolicy' 

Fields

  • domainOwner :: Maybe Text

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

  • policyRevision :: Maybe Text

    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.

  • domain :: Text

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

  • policyDocument :: Text

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

Instances

Instances details
ToJSON PutDomainPermissionsPolicy Source # 
Instance details

Defined in Amazonka.CodeArtifact.PutDomainPermissionsPolicy

ToHeaders PutDomainPermissionsPolicy Source # 
Instance details

Defined in Amazonka.CodeArtifact.PutDomainPermissionsPolicy

ToPath PutDomainPermissionsPolicy Source # 
Instance details

Defined in Amazonka.CodeArtifact.PutDomainPermissionsPolicy

ToQuery PutDomainPermissionsPolicy Source # 
Instance details

Defined in Amazonka.CodeArtifact.PutDomainPermissionsPolicy

AWSRequest PutDomainPermissionsPolicy Source # 
Instance details

Defined in Amazonka.CodeArtifact.PutDomainPermissionsPolicy

Generic PutDomainPermissionsPolicy Source # 
Instance details

Defined in Amazonka.CodeArtifact.PutDomainPermissionsPolicy

Associated Types

type Rep PutDomainPermissionsPolicy :: Type -> Type #

Read PutDomainPermissionsPolicy Source # 
Instance details

Defined in Amazonka.CodeArtifact.PutDomainPermissionsPolicy

Show PutDomainPermissionsPolicy Source # 
Instance details

Defined in Amazonka.CodeArtifact.PutDomainPermissionsPolicy

NFData PutDomainPermissionsPolicy Source # 
Instance details

Defined in Amazonka.CodeArtifact.PutDomainPermissionsPolicy

Eq PutDomainPermissionsPolicy Source # 
Instance details

Defined in Amazonka.CodeArtifact.PutDomainPermissionsPolicy

Hashable PutDomainPermissionsPolicy Source # 
Instance details

Defined in Amazonka.CodeArtifact.PutDomainPermissionsPolicy

type AWSResponse PutDomainPermissionsPolicy Source # 
Instance details

Defined in Amazonka.CodeArtifact.PutDomainPermissionsPolicy

type Rep PutDomainPermissionsPolicy Source # 
Instance details

Defined in Amazonka.CodeArtifact.PutDomainPermissionsPolicy

type Rep PutDomainPermissionsPolicy = D1 ('MetaData "PutDomainPermissionsPolicy" "Amazonka.CodeArtifact.PutDomainPermissionsPolicy" "amazonka-codeartifact-2.0-CskMABZQLQJDgej73fXQxp" 'False) (C1 ('MetaCons "PutDomainPermissionsPolicy'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "domainOwner") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "policyRevision") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "domain") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "policyDocument") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newPutDomainPermissionsPolicy Source #

Create a value of PutDomainPermissionsPolicy with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

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

$sel:policyRevision:PutDomainPermissionsPolicy', putDomainPermissionsPolicy_policyRevision - 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.

$sel:domain:PutDomainPermissionsPolicy', putDomainPermissionsPolicy_domain - The name of the domain on which to set the resource policy.

$sel:policyDocument:PutDomainPermissionsPolicy', putDomainPermissionsPolicy_policyDocument - A valid displayable JSON Aspen policy string to be set as the access control resource policy on the provided domain.

Request Lenses

putDomainPermissionsPolicy_domainOwner :: Lens' PutDomainPermissionsPolicy (Maybe Text) Source #

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

putDomainPermissionsPolicy_policyRevision :: Lens' PutDomainPermissionsPolicy (Maybe Text) Source #

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.

putDomainPermissionsPolicy_domain :: Lens' PutDomainPermissionsPolicy Text Source #

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

putDomainPermissionsPolicy_policyDocument :: Lens' PutDomainPermissionsPolicy Text Source #

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

Destructuring the Response

data PutDomainPermissionsPolicyResponse Source #

Constructors

PutDomainPermissionsPolicyResponse' 

Fields

Instances

Instances details
Generic PutDomainPermissionsPolicyResponse Source # 
Instance details

Defined in Amazonka.CodeArtifact.PutDomainPermissionsPolicy

Associated Types

type Rep PutDomainPermissionsPolicyResponse :: Type -> Type #

Read PutDomainPermissionsPolicyResponse Source # 
Instance details

Defined in Amazonka.CodeArtifact.PutDomainPermissionsPolicy

Show PutDomainPermissionsPolicyResponse Source # 
Instance details

Defined in Amazonka.CodeArtifact.PutDomainPermissionsPolicy

NFData PutDomainPermissionsPolicyResponse Source # 
Instance details

Defined in Amazonka.CodeArtifact.PutDomainPermissionsPolicy

Eq PutDomainPermissionsPolicyResponse Source # 
Instance details

Defined in Amazonka.CodeArtifact.PutDomainPermissionsPolicy

type Rep PutDomainPermissionsPolicyResponse Source # 
Instance details

Defined in Amazonka.CodeArtifact.PutDomainPermissionsPolicy

type Rep PutDomainPermissionsPolicyResponse = D1 ('MetaData "PutDomainPermissionsPolicyResponse" "Amazonka.CodeArtifact.PutDomainPermissionsPolicy" "amazonka-codeartifact-2.0-CskMABZQLQJDgej73fXQxp" 'False) (C1 ('MetaCons "PutDomainPermissionsPolicyResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "policy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ResourcePolicy)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newPutDomainPermissionsPolicyResponse Source #

Create a value of PutDomainPermissionsPolicyResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:policy:PutDomainPermissionsPolicyResponse', putDomainPermissionsPolicyResponse_policy - The resource policy that was set after processing the request.

$sel:httpStatus:PutDomainPermissionsPolicyResponse', putDomainPermissionsPolicyResponse_httpStatus - The response's http status code.

Response Lenses

putDomainPermissionsPolicyResponse_policy :: Lens' PutDomainPermissionsPolicyResponse (Maybe ResourcePolicy) Source #

The resource policy that was set after processing the request.