software.amazon.awssdk.services.ram.model.CreatePermissionVersionRequest Maven / Gradle / Ivy
Show all versions of ram Show documentation
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.ram.model;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class CreatePermissionVersionRequest extends RamRequest implements
ToCopyableBuilder {
private static final SdkField PERMISSION_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("permissionArn").getter(getter(CreatePermissionVersionRequest::permissionArn))
.setter(setter(Builder::permissionArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("permissionArn").build()).build();
private static final SdkField POLICY_TEMPLATE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("policyTemplate").getter(getter(CreatePermissionVersionRequest::policyTemplate))
.setter(setter(Builder::policyTemplate))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("policyTemplate").build()).build();
private static final SdkField CLIENT_TOKEN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("clientToken").getter(getter(CreatePermissionVersionRequest::clientToken))
.setter(setter(Builder::clientToken))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("clientToken").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(PERMISSION_ARN_FIELD,
POLICY_TEMPLATE_FIELD, CLIENT_TOKEN_FIELD));
private static final Map> SDK_NAME_TO_FIELD = Collections
.unmodifiableMap(new HashMap>() {
{
put("permissionArn", PERMISSION_ARN_FIELD);
put("policyTemplate", POLICY_TEMPLATE_FIELD);
put("clientToken", CLIENT_TOKEN_FIELD);
}
});
private final String permissionArn;
private final String policyTemplate;
private final String clientToken;
private CreatePermissionVersionRequest(BuilderImpl builder) {
super(builder);
this.permissionArn = builder.permissionArn;
this.policyTemplate = builder.policyTemplate;
this.clientToken = builder.clientToken;
}
/**
*
* Specifies the Amazon
* Resource Name (ARN) of the customer managed permission you're creating a new version for.
*
*
* @return Specifies the Amazon
* Resource Name (ARN) of the customer managed permission you're creating a new version for.
*/
public final String permissionArn() {
return permissionArn;
}
/**
*
* A string in JSON format string that contains the following elements of a resource-based policy:
*
*
* -
*
* Effect: must be set to ALLOW.
*
*
* -
*
* Action: specifies the actions that are allowed by this customer managed permission. The list must contain
* only actions that are supported by the specified resource type. For a list of all actions supported by each
* resource type, see Actions, resources, and condition keys for Amazon Web Services services in the Identity and Access
* Management User Guide.
*
*
* -
*
* Condition: (optional) specifies conditional parameters that must evaluate to true when a user attempts an
* action for that action to be allowed. For more information about the Condition element, see IAM policies:
* Condition element in the Identity and Access Management User Guide.
*
*
*
*
* This template can't include either the Resource or Principal elements. Those are both
* filled in by RAM when it instantiates the resource-based policy on each resource shared using this managed
* permission. The Resource comes from the ARN of the specific resource that you are sharing. The
* Principal comes from the list of identities added to the resource share.
*
*
* @return A string in JSON format string that contains the following elements of a resource-based policy:
*
* -
*
* Effect: must be set to ALLOW.
*
*
* -
*
* Action: specifies the actions that are allowed by this customer managed permission. The list must
* contain only actions that are supported by the specified resource type. For a list of all actions
* supported by each resource type, see Actions, resources, and condition keys for Amazon Web Services services in the Identity and
* Access Management User Guide.
*
*
* -
*
* Condition: (optional) specifies conditional parameters that must evaluate to true when a user
* attempts an action for that action to be allowed. For more information about the Condition element, see
* IAM
* policies: Condition element in the Identity and Access Management User Guide.
*
*
*
*
* This template can't include either the Resource or Principal elements. Those
* are both filled in by RAM when it instantiates the resource-based policy on each resource shared using
* this managed permission. The Resource comes from the ARN of the specific resource that you
* are sharing. The Principal comes from the list of identities added to the resource share.
*/
public final String policyTemplate() {
return policyTemplate;
}
/**
*
* Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This
* lets you safely retry the request without accidentally performing the same operation a second time. Passing the
* same value to a later call to an operation requires that you also pass the same value for all other parameters.
* We recommend that you use a UUID type of
* value..
*
*
* If you don't provide this value, then Amazon Web Services generates a random one for you.
*
*
* If you retry the operation with the same ClientToken, but with different parameters, the retry fails
* with an IdempotentParameterMismatch error.
*
*
* @return Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
* This lets you safely retry the request without accidentally performing the same operation a second time.
* Passing the same value to a later call to an operation requires that you also pass the same value for all
* other parameters. We recommend that you use a UUID type of value..
*
* If you don't provide this value, then Amazon Web Services generates a random one for you.
*
*
* If you retry the operation with the same ClientToken, but with different parameters, the
* retry fails with an IdempotentParameterMismatch error.
*/
public final String clientToken() {
return clientToken;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(permissionArn());
hashCode = 31 * hashCode + Objects.hashCode(policyTemplate());
hashCode = 31 * hashCode + Objects.hashCode(clientToken());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof CreatePermissionVersionRequest)) {
return false;
}
CreatePermissionVersionRequest other = (CreatePermissionVersionRequest) obj;
return Objects.equals(permissionArn(), other.permissionArn()) && Objects.equals(policyTemplate(), other.policyTemplate())
&& Objects.equals(clientToken(), other.clientToken());
}
/**
* Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
* redacted from this string using a placeholder value.
*/
@Override
public final String toString() {
return ToString.builder("CreatePermissionVersionRequest").add("PermissionArn", permissionArn())
.add("PolicyTemplate", policyTemplate()).add("ClientToken", clientToken()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "permissionArn":
return Optional.ofNullable(clazz.cast(permissionArn()));
case "policyTemplate":
return Optional.ofNullable(clazz.cast(policyTemplate()));
case "clientToken":
return Optional.ofNullable(clazz.cast(clientToken()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
@Override
public final Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
private static Function getter(Function g) {
return obj -> g.apply((CreatePermissionVersionRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends RamRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* Specifies the Amazon
* Resource Name (ARN) of the customer managed permission you're creating a new version for.
*
*
* @param permissionArn
* Specifies the Amazon Resource Name
* (ARN) of the customer managed permission you're creating a new version for.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder permissionArn(String permissionArn);
/**
*
* A string in JSON format string that contains the following elements of a resource-based policy:
*
*
* -
*
* Effect: must be set to ALLOW.
*
*
* -
*
* Action: specifies the actions that are allowed by this customer managed permission. The list must
* contain only actions that are supported by the specified resource type. For a list of all actions supported
* by each resource type, see Actions, resources, and condition keys for Amazon Web Services services in the Identity and Access
* Management User Guide.
*
*
* -
*
* Condition: (optional) specifies conditional parameters that must evaluate to true when a user attempts
* an action for that action to be allowed. For more information about the Condition element, see IAM
* policies: Condition element in the Identity and Access Management User Guide.
*
*
*
*
* This template can't include either the Resource or Principal elements. Those are
* both filled in by RAM when it instantiates the resource-based policy on each resource shared using this
* managed permission. The Resource comes from the ARN of the specific resource that you are
* sharing. The Principal comes from the list of identities added to the resource share.
*
*
* @param policyTemplate
* A string in JSON format string that contains the following elements of a resource-based policy:
*
* -
*
* Effect: must be set to ALLOW.
*
*
* -
*
* Action: specifies the actions that are allowed by this customer managed permission. The list
* must contain only actions that are supported by the specified resource type. For a list of all actions
* supported by each resource type, see Actions, resources, and condition keys for Amazon Web Services services in the Identity and
* Access Management User Guide.
*
*
* -
*
* Condition: (optional) specifies conditional parameters that must evaluate to true when a user
* attempts an action for that action to be allowed. For more information about the Condition element,
* see IAM
* policies: Condition element in the Identity and Access Management User Guide.
*
*
*
*
* This template can't include either the Resource or Principal elements. Those
* are both filled in by RAM when it instantiates the resource-based policy on each resource shared using
* this managed permission. The Resource comes from the ARN of the specific resource that
* you are sharing. The Principal comes from the list of identities added to the resource
* share.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder policyTemplate(String policyTemplate);
/**
*
* Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This
* lets you safely retry the request without accidentally performing the same operation a second time. Passing
* the same value to a later call to an operation requires that you also pass the same value for all other
* parameters. We recommend that you use a UUID type of value..
*
*
* If you don't provide this value, then Amazon Web Services generates a random one for you.
*
*
* If you retry the operation with the same ClientToken, but with different parameters, the retry
* fails with an IdempotentParameterMismatch error.
*
*
* @param clientToken
* Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the
* request. This lets you safely retry the request without accidentally performing the same operation a
* second time. Passing the same value to a later call to an operation requires that you also pass the
* same value for all other parameters. We recommend that you use a UUID type of value..
*
* If you don't provide this value, then Amazon Web Services generates a random one for you.
*
*
* If you retry the operation with the same ClientToken, but with different parameters, the
* retry fails with an IdempotentParameterMismatch error.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder clientToken(String clientToken);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends RamRequest.BuilderImpl implements Builder {
private String permissionArn;
private String policyTemplate;
private String clientToken;
private BuilderImpl() {
}
private BuilderImpl(CreatePermissionVersionRequest model) {
super(model);
permissionArn(model.permissionArn);
policyTemplate(model.policyTemplate);
clientToken(model.clientToken);
}
public final String getPermissionArn() {
return permissionArn;
}
public final void setPermissionArn(String permissionArn) {
this.permissionArn = permissionArn;
}
@Override
public final Builder permissionArn(String permissionArn) {
this.permissionArn = permissionArn;
return this;
}
public final String getPolicyTemplate() {
return policyTemplate;
}
public final void setPolicyTemplate(String policyTemplate) {
this.policyTemplate = policyTemplate;
}
@Override
public final Builder policyTemplate(String policyTemplate) {
this.policyTemplate = policyTemplate;
return this;
}
public final String getClientToken() {
return clientToken;
}
public final void setClientToken(String clientToken) {
this.clientToken = clientToken;
}
@Override
public final Builder clientToken(String clientToken) {
this.clientToken = clientToken;
return this;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public CreatePermissionVersionRequest build() {
return new CreatePermissionVersionRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
@Override
public Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
}
}